conf.py 7.63 KB
Newer Older
1
2
3
4
5
6
7
8
# -*- coding: utf-8 -*-
#
# graph-tool documentation build configuration file, created by
# sphinx-quickstart on Sun Oct 26 18:29:16 2008.
#
# This file is execfile()d with the current directory set to its containing dir.
#
# The contents of this file are pickled, so don't put values in the namespace
9
10
# that aren't pickleable (module imports are okay, they're removed
# automatically).
11
12
13
14
15
16
17
18
19
#
# All configuration values have a default; values that are commented out
# serve to show the default.

import sys, os

# If your extensions are in another directory, add it here. If the directory
# is relative to the documentation root, use os.path.abspath to make it
# absolute, like shown here.
20
sys.path.append(os.path.abspath('.'))
21
22
23
24
25
26
27

# General configuration
# ---------------------

# Add any Sphinx extension module names here, as strings. They can be extensions
# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
extensions = ['sphinx.ext.autodoc', 'sphinx.ext.doctest',
28
29
              'sphinx.ext.intersphinx', 'mathjax', 'sphinx.ext.autosummary',
              'sphinxext.numpydoc', 'sphinx.ext.extlinks']
30

31
32
33
numpydoc_show_class_members = False

mathjax_path = "MathJax/MathJax.js"
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48

# Add any paths that contain templates here, relative to this directory.
templates_path = ['.templates']

# The suffix of source filenames.
source_suffix = '.rst'

# The encoding of source files.
#source_encoding = 'utf-8'

# The master toctree document.
master_doc = 'index'

# General information about the project.
project = u'graph-tool'
Tiago Peixoto's avatar
Tiago Peixoto committed
49
copyright = u'2010, Tiago de Paula Peixoto <tiago@skewed.de>'
50
51
52
53
54
55

# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
# built documents.
#
# The short X.Y version.
56
57
from graph_tool import __version__ as gt_version
version = gt_version.split()[0]
58
# The full version, including alpha/beta/rc tags.
59
release = gt_version.split()[0]
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94

# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
#language = None

# There are two options for replacing |today|: either, you set today to some
# non-false value, then it is used:
#today = ''
# Else, today_fmt is used as the format for a strftime call.
#today_fmt = '%B %d, %Y'

# List of documents that shouldn't be included in the build.
#unused_docs = []

# List of directories, relative to source directory, that shouldn't be searched
# for source files.
exclude_trees = ['.build']

# The reST default role (used for this markup: `text`) to use for all documents.
#default_role = None

# If true, '()' will be appended to :func: etc. cross-reference text.
#add_function_parentheses = True

# If true, the current module name will be prepended to all description
# unit titles (such as .. function::).
#add_module_names = True

# If true, sectionauthor and moduleauthor directives will be shown in the
# output. They are ignored by default.
#show_authors = False

# The name of the Pygments (syntax highlighting) style to use.
pygments_style = 'sphinx'

95
96
97
# doctest

doctest_global_setup = \
98
r"""
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
from matplotlib import rc
from matplotlib import rcParams

font_size=12
rcParams["figure.figsize"] = (4,3)
rcParams["font.family"] = "serif"
rcParams["font.serif"] = ["Palatino"]
rcParams["font.size"] = font_size
rcParams["axes.labelsize"] = font_size
rcParams["xtick.labelsize"] = font_size
rcParams["ytick.labelsize"] = font_size
rcParams["legend.numpoints"] = 1
rcParams["legend.fontsize"] = "small"
rcParams["lines.markersize"] = 4
rcParams["figure.subplot.right"] = 0.95
rcParams["figure.subplot.top"] = 0.95
rcParams["figure.subplot.right"] = 0.95
rcParams["figure.subplot.top"] = 0.95
rcParams["figure.subplot.left"] = 0.2
rcParams["figure.subplot.bottom"] = 0.2

rcParams["text.usetex"] = True

rcParams["ps.usedistiller"] = "xpdf"
rcParams["pdf.compression"] = 9
rcParams["ps.useafm"] = True
rcParams["path.simplify"] = True
126
127
rcParams["text.latex.preamble"] = ["\usepackage{times}",
                                   #"\usepackage{euler}",
128
129
130
                                   "\usepackage{amssymb}",
                                   "\usepackage{amsmath}"]

131
from numpy import *
132
133
import scipy
import scipy.stats
134
from math import *
Tiago Peixoto's avatar
Tiago Peixoto committed
135
import numpy as np
136
import graph_tool.all as gt
137
"""
138

139
# Options for HTML outputs
140
141
142
143
144
# -----------------------

# The style sheet to use for HTML and HTML Help pages. A file of that name
# must exist either in Sphinx' static/ path, or in one of the custom paths
# given in html_static_path.
145
146
147
148
# html_style = 'default.css'

html_theme = "gt_theme"
html_theme_path = ["."]
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163

# The name for this set of Sphinx documents.  If None, it defaults to
# "<project> v<release> documentation".
#html_title = None

# A shorter title for the navigation bar.  Default is the same as html_title.
#html_short_title = None

# The name of an image file (relative to this directory) to place at the top
# of the sidebar.
#html_logo = None

# The name of an image file (within the static path) to use as favicon of the
# docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
# pixels large.
164
html_favicon = "graph-icon.ico"
165
166
167
168
169
170
171
172

# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ['.static']

# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
# using the given strftime format.
173
html_last_updated_fmt = '%b %d, %Y'
174
175
176

# If true, SmartyPants will be used to convert quotes and dashes to
# typographically correct entities.
177
html_use_smartypants = True
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195

# Custom sidebar templates, maps document names to template names.
#html_sidebars = {}

# Additional templates that should be rendered to pages, maps page names to
# template names.
#html_additional_pages = {}

# If false, no module index is generated.
#html_use_modindex = True

# If false, no index is generated.
#html_use_index = True

# If true, the index is split into individual pages for each letter.
#html_split_index = False

# If true, the reST sources are included in the HTML build as _sources/<name>.
196
html_copy_source = True
197
198
199
200

# If true, an OpenSearch description file will be output, and all pages will
# contain a <link> tag referring to it.  The value of this option must be the
# base URL from which the finished HTML is served.
Tiago Peixoto's avatar
Tiago Peixoto committed
201
html_use_opensearch = 'http://projects.skewed.de/graph-tool/doc/'
202
203
204
205
206
207
208
209
210
211
212

# If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml").
#html_file_suffix = ''

# Output file base name for HTML help builder.
htmlhelp_basename = 'graph-tooldoc'


# Options for LaTeX output
# ------------------------

213
214
# Grouping the document tree into LaTeX files. List of tuples (source start
# file, target name, title, author, document class [howto/manual]).
215
latex_documents = [
216
  ('index', 'graph-tool.tex', ur'graph-tool documentation',
217
218
219
   ur'Tiago de Paula Peixoto', 'manual'),
]

220
#latex_logo = "graph-draw.png"
221

222
latex_elements = {
Tiago Peixoto's avatar
Tiago Peixoto committed
223
224
    'papersize': "a4paper",
    'fontpkg': r"\usepackage{palatino}\usepackage{eulervm}"}
225
226
227


# Example configuration for intersphinx: refer to the Python standard library.
228
229
230
intersphinx_mapping = {'http://docs.python.org': None,
                       'http://docs.scipy.org/doc/numpy': None,
                       'http://docs.scipy.org/doc/scipy/reference': None,
Tiago Peixoto's avatar
Tiago Peixoto committed
231
                       'http://matplotlib.sourceforge.net': None}
232
233
234

extlinks = {'ticket': ('http://projects.skewed.de/graph-tool/ticket/%s',
                       'ticket '),
Tiago Peixoto's avatar
Tiago Peixoto committed
235
236
            'doi': ('http://dx.doi.org/%s', 'DOI: '),
            'arxiv': ('http://arxiv.org/abs/%s', 'arXiv: ')}
237

Tiago Peixoto's avatar
Tiago Peixoto committed
238
239
autodoc_member_order = 'bysource'
autodoc_default_flags = ['members']