conf.py 7.87 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
              'sphinx.ext.intersphinx', 'mathjax', 'sphinx.ext.autosummary',
Tiago Peixoto's avatar
Tiago Peixoto committed
29
              'numpydoc',
Tiago Peixoto's avatar
Tiago Peixoto committed
30
              'sphinx.ext.extlinks',
31
32
              'sphinx.ext.viewcode'
              #'sphinx.ext.linkcode'
Tiago Peixoto's avatar
Tiago Peixoto committed
33
34
              #'matplotlib.sphinxext.plot_directive'
              ]
35

36
mathjax_path = "MathJax/MathJax.js?config=default"
37
38
39
40
41
42
43
44

# 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.
45
source_encoding = 'utf-8'
46
47
48
49
50
51

# The master toctree document.
master_doc = 'index'

# General information about the project.
project = u'graph-tool'
Tiago Peixoto's avatar
Tiago Peixoto committed
52
copyright = u'2015, Tiago de Paula Peixoto <tiago@skewed.de>'
53
54
55
56
57
58

# 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.
59
60
from graph_tool import __version__ as gt_version
version = gt_version.split()[0]
61
# The full version, including alpha/beta/rc tags.
62
release = gt_version.split()[0]
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
95
96
97

# 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'

98
99
# doctest

100
doctest_global_setup = open("pyenv.py").read()
101

102
# Options for HTML outputs
103
104
105
106
107
# -----------------------

# 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.
108
109
110
111
# html_style = 'default.css'

html_theme = "gt_theme"
html_theme_path = ["."]
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126

# 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.
127
html_favicon = "graph-icon.ico"
128
129
130
131
132
133
134
135

# 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.
136
html_last_updated_fmt = '%b %d, %Y'
137
138
139

# If true, SmartyPants will be used to convert quotes and dashes to
# typographically correct entities.
140
html_use_smartypants = True
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158

# 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>.
159
html_copy_source = True
160
161
162
163

# 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
164
html_use_opensearch = 'http://graph-tool.skewed.de/doc/'
165
166
167
168
169
170
171
172
173
174
175

# 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
# ------------------------

176
177
# Grouping the document tree into LaTeX files. List of tuples (source start
# file, target name, title, author, document class [howto/manual]).
178
latex_documents = [
179
  ('index', 'graph-tool.tex', ur'graph-tool documentation',
180
181
182
   ur'Tiago de Paula Peixoto', 'manual'),
]

183
184
185
186
187
188
189
190
191
latex_preamble = """
\setcounter{tocdepth}{2}
"""

latex_show_pagerefs = True
latex_show_urls = False
latex_paper_size = "a4"

latex_logo = "blockmodel.pdf"
192

193
latex_elements = {
Tiago Peixoto's avatar
Tiago Peixoto committed
194
    'papersize': "a4paper",
195
    'fontpkg': r"\usepackage{bookman}"}
196
197

# Example configuration for intersphinx: refer to the Python standard library.
198
intersphinx_mapping = {'python': ('http://docs.python.org/3', None),
199
                       'numpy': ('http://docs.scipy.org/doc/numpy', None),
200
201
                       'scipy': ('http://docs.scipy.org/doc/scipy/reference', None),
                       'matplotlib': ('http://matplotlib.sourceforge.net', None),
Tiago Peixoto's avatar
Tiago Peixoto committed
202
203
204
                       'cairo': ('http://www.cairographics.org/documentation/pycairo/3/', None),
                       'ipython': ('http://ipython.org/ipython-doc/stable/', None),
                       'panda': ('http://pandas.pydata.org/pandas-docs/stable/', None)}
205

Tiago Peixoto's avatar
Tiago Peixoto committed
206
extlinks = {'ticket': ('http://graph-tool.skewed.de/tickets/ticket/%s',
207
                       'ticket '),
Tiago Peixoto's avatar
Tiago Peixoto committed
208
209
            'doi': ('http://dx.doi.org/%s', 'DOI: '),
            'arxiv': ('http://arxiv.org/abs/%s', 'arXiv: ')}
210

Tiago Peixoto's avatar
Tiago Peixoto committed
211

Tiago Peixoto's avatar
Tiago Peixoto committed
212
213
214
215
216
217
# def process_docstring(app, what, name, obj, options, lines):
#     for i, line in enumerate(lines):
#         if "arg1" in line and "->" in line:
#             lines[i] = ""
#         if "C++ signature :" in line or "graph_tool::Python" in line:
#             lines[i] = ""
218

Tiago Peixoto's avatar
Tiago Peixoto committed
219
220
# def setup(app):
#     app.connect('autodoc-process-docstring', process_docstring)
221

222
223
224
225
# plot directive
import pyenv
plot_rcparams = pyenv.rcParams
#plot_pre_code = open("pyenv.py").read()
226
227
228
229
230

autodoc_default_flags = ['members', 'undoc-members']
numpydoc_show_class_members = False
autodoc_docstring_signature = False
autodoc_member_order = 'bysource'
231
autoclass_content = 'both'
Tiago Peixoto's avatar
Tiago Peixoto committed
232
imported_members = True
233
234
235
236
237
238
239
240

def linkcode_resolve(domain, info):
    if domain != 'py':
        return None
    if not info['module']:
        return None
    modname = info['module'].replace('.', '/')
    return "https://git.skewed.de/count0/graph-tool/tree/master/src/%s/__init__.py" % modname