conf.py 7.33 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
#
# All configuration values have a default; values that are commented out
# serve to show the default.

import sys, os

Tiago Peixoto's avatar
Tiago Peixoto committed
17 18 19 20
if sys.version_info < (3,):
    reload(sys)
    sys.setdefaultencoding("Cp1252")

21 22 23
# 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.
24
sys.path.append(os.path.abspath('.'))
25 26 27 28 29 30 31

# 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',
Tiago Peixoto's avatar
Tiago Peixoto committed
32 33
              'sphinx.ext.intersphinx', 'sphinx.ext.mathjax',
              'sphinx.ext.autosummary',
Tiago Peixoto's avatar
Tiago Peixoto committed
34
              'numpydoc',
35
              'sphinx.ext.extlinks',
Tiago Peixoto's avatar
Tiago Peixoto committed
36 37
              'sphinx.ext.viewcode',
              'extlinks_fancy',
38
              #'sphinx.ext.linkcode'
39 40
              #'matplotlib.sphinxext.plot_directive'
              ]
41

42
mathjax_path = "MathJax/MathJax.js?config=default"
43 44 45 46 47 48 49 50

# 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.
51
source_encoding = 'utf-8'
52 53 54 55 56 57

# The master toctree document.
master_doc = 'index'

# General information about the project.
project = u'graph-tool'
58
copyright = u'2018, Tiago de Paula Peixoto <tiago@skewed.de>'
59 60 61 62 63 64

# 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.
65 66
from graph_tool import __version__ as gt_version
version = gt_version.split()[0]
67
# The full version, including alpha/beta/rc tags.
68
release = gt_version.split()[0]
69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86

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

87 88
exclude_patterns = ['**/_*.rst']

89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105
# 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'

106 107
# doctest

108
doctest_global_setup = open("pyenv.py").read()
Tiago Peixoto's avatar
Tiago Peixoto committed
109
doctest_global_setup += "os.chdir('%s')\n" % os.getcwd()
110

111
# Options for HTML outputs
112 113 114 115 116
# -----------------------

# 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.
117 118 119 120
# html_style = 'default.css'

html_theme = "gt_theme"
html_theme_path = ["."]
121 122 123 124 125 126 127 128 129 130 131 132 133 134 135

# 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.
136
html_favicon = "graph-icon.ico"
137 138 139 140 141 142 143 144

# 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.
145
html_last_updated_fmt = '%b %d, %Y'
146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163

# 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>.
164
html_copy_source = True
165 166 167 168

# 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
169
html_use_opensearch = 'http://graph-tool.skewed.de/doc/'
170 171 172 173 174 175 176 177 178

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


# Example configuration for intersphinx: refer to the Python standard library.
Tiago Peixoto's avatar
Tiago Peixoto committed
179
intersphinx_mapping = {'python': ('https://docs.python.org/3', None),
180 181 182
                       'numpy': ('https://docs.scipy.org/doc/numpy', None),
                       'scipy': ('https://docs.scipy.org/doc/scipy/reference', None),
                       'matplotlib': ('https://matplotlib.org', None),
Tiago Peixoto's avatar
Tiago Peixoto committed
183
                       'cairo': ('https://www.cairographics.org/documentation/pycairo/3', None),
184 185
                       'ipython': ('https://ipython.org/ipython-doc/stable/', None),
                       'panda': ('https://pandas.pydata.org/pandas-docs/stable/', None)}
186

187 188
extlinks_fancy = {'issue': (['https://git.skewed.de/count0/graph-tool/issues/{0}'],
                             ['issue #{0}']),
Tiago Peixoto's avatar
Tiago Peixoto committed
189
                  'doi': (['https://dx.doi.org/{0}',
190
                           'https://sci-hub.tw/{0}',
Tiago Peixoto's avatar
Tiago Peixoto committed
191 192 193
                           'https://scihub22266oqcxt.onion.link/{0}'],
                          ['DOI: {0}', "sci-hub", "@tor"]),
                  'arxiv': (['https://arxiv.org/abs/{0}'], ['arXiv: {0}'])}
194

195 196 197 198
# plot directive
import pyenv
plot_rcparams = pyenv.rcParams
#plot_pre_code = open("pyenv.py").read()
199

Tiago Peixoto's avatar
Tiago Peixoto committed
200 201 202 203 204 205 206

autodoc_default_options = {
    'members': True,
    'member-order': 'bysource',
    'undoc-members': True
}

Tiago Peixoto's avatar
Tiago Peixoto committed
207
autosummary_gerenerate = True
208 209
numpydoc_show_class_members = False
autodoc_docstring_signature = False
210
autoclass_content = 'both'
Tiago Peixoto's avatar
Tiago Peixoto committed
211
imported_members = True
212 213 214 215 216 217 218 219

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
220 221

nitpicky = True