conf.py 11.4 KB
Newer Older
1
2
# -*- coding: utf-8 -*-
#
3
# Kwant documentation build configuration file, created by
4
5
6
7
8
9
10
11
12
13
# sphinx-quickstart on Tue Jan 11 09:39:28 2011.
#
# This file is execfile()d with the current directory set to its containing dir.
#
# Note that not all possible configuration values are present in this
# autogenerated file.
#
# All configuration values have a default; values that are commented out
# serve to show the default.

14
15
16
import sys
import os
import string
17
from distutils.util import get_platform
18
19
20
21
22
23
24
25
26

package_path = os.path.abspath(
    "../../build/lib.{0}-{1}.{2}"
    .format(get_platform(), *sys.version_info[:2]))

# Insert into sys.path so that we can import kwant here
sys.path.insert(0, package_path)
# Insert into PYTHONPATH so that jupyter-sphinx will pick it up
os.environ['PYTHONPATH'] = ':'.join((package_path, os.environ.get('PYTHONPATH','')))
27

28
import kwant
29
import kwant.qsymm
30
import kwant.continuum  # sphinx gets confused with lazy loading
31
32
33
34
35
36
37
38
39

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

sys.path.insert(0, os.path.abspath('../sphinxext'))

extensions = ['sphinx.ext.autodoc', 'sphinx.ext.autosummary',
40
              'sphinx.ext.todo', 'sphinx.ext.mathjax', 'sphinx.ext.napoleon',
41
              'kwantdoc', 'sphinx.ext.linkcode', 'jupyter_sphinx',
42
              'sphinxcontrib.rsvgconverter']
43
44
45
46
47
48
49
50
51
52
53
54
55
56

# 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.
Joseph Weston's avatar
Joseph Weston committed
57
project = 'Kwant'
58
copyright = '2011-2017, C. W. Groth (CEA), M. Wimmer, A. R. Akhmerov, X. Waintal (CEA), and others'
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 full version, including alpha/beta/rc tags.
65
release = kwant.__version__
66
67

# The short X.Y version.
68
version = release[:len(release) - len(release.lstrip('012345679.'))].rstrip('.')
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
98
99
100
101
102
103
104
105
106
107
108
109

# 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 = []

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

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

# A list of ignored prefixes for module index sorting.
#modindex_common_prefix = []

# Do not show all class members automatically in the class documentation
numpydoc_show_class_members = False

Joseph Weston's avatar
Joseph Weston committed
110
111
112
113
114
115
116
117
118
# Jupyter Sphinx config

jupyter_sphinx_thebelab_config = {
    "binderOptions": {
        "repo": "kwant-project/binder",
        "ref": "master",
    }
}

119
120
121
122
# -- Options for HTML output ---------------------------------------------------

# The theme to use for HTML and HTML Help pages.  Major themes that come with
# Sphinx are currently 'default' and 'sphinxdoc'.
Christoph Groth's avatar
Christoph Groth committed
123
124
125
html_theme = 'kwantdoctheme'
html_theme_path = ['..']
html_theme_options = {'collapsiblesidebar': True}
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
html_style = 'kwant.css'

# Theme options are theme-specific and customize the look and feel of a theme
# further.  For a list of options available for each theme, see the
# documentation.
#html_theme_options = {}

# Add any paths that contain custom themes here, relative to this directory.
#html_theme_path = []

# 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.
#html_favicon = None

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

# If true, SmartyPants will be used to convert quotes and dashes to
# typographically correct entities.
#html_use_smartypants = True

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

# This is needed too.
html_domain_indices = False

# 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, links to the reST sources are added to the pages.
#html_show_sourcelink = True

# 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.
#html_use_opensearch = ''

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


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

201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
latex_elements = {'papersize': 'a4paper',
                  'release': '',
                  'releasename': '',
                  'preamble':
r"""\makeatletter
  \fancypagestyle{normal}{
    \fancyhf{}
    \fancyfoot[LE,RO]{{\py@HeaderFamily\thepage}}
    \fancyfoot[LO]{{\py@HeaderFamily\nouppercase{\rightmark}}}
    \fancyfoot[RE]{{\py@HeaderFamily\nouppercase{\leftmark}}}
    \fancyhead[LE,RO]{{\py@HeaderFamily \@title}}
    \renewcommand{\headrulewidth}{0.4pt}
    \renewcommand{\footrulewidth}{0.4pt}
  }
\makeatother
216
217
218
219
220
221

\newcommand{\bra}[1]{\left\langle#1\right|}
\newcommand{\ket}[1]{\left|#1\right>}
\newcommand{\braket}[2]{\left\langle#1|#2\right\rangle}
\newcommand{\ri}{\text{i}}
\newcommand{\rd}{\text{d}}
222
223

\usepackage{unicode-math}
224
"""}
225
226
227

# Grouping the document tree into LaTeX files. List of tuples
# (source start file, target name, title, author, documentclass [howto/manual]).
228
# We use "et al." as it is shorter and there's not much space left horizontally.
229
latex_documents = [
230
  ('index', 'kwant.tex', 'Kwant {0} documentation'.format(release),
Joseph Weston's avatar
Joseph Weston committed
231
   'C. W. Groth, M. Wimmer, A. R. Akhmerov, X. Waintal, et al.',
232
233
234
   'manual'),
]

235
236
latex_engine = 'xelatex'

Joseph Weston's avatar
Joseph Weston committed
237
238
latex_use_xindy = False  # Xindy not installable in CI environment

239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
# The name of an image file (relative to this directory) to place at the top of
# the title page.
#latex_logo = None

# For "manual" documents, if this is true, then toplevel headings are parts,
# not chapters.
#latex_use_parts = False

# Documents to append as an appendix to all manuals.
#latex_appendices = []

# This is needed too.
latex_domain_indices = False

# -- Options for autodoc -------------------------------------------------------
# Generate stub pages for autosummary directives.
autosummary_generate = True

autoclass_content = "both"
Joseph Weston's avatar
Joseph Weston committed
258
259
260
autodoc_default_options = {
    'show-inheritance': True,
}
Christoph Groth's avatar
Christoph Groth committed
261
262
263
264
265
266
267
268
269
270
271
272

# -- Teach Sphinx to document bound methods like functions ---------------------
import types
from sphinx.ext import autodoc

class BoundMethodDocumenter(autodoc.FunctionDocumenter):
    objtype = "boundmethod"
    directivetype = 'function'

    @classmethod
    def can_document_member(cls, member, membername, isattr, parent):
        # Return True iff `member` is a bound method.  Taken from
273
        # <https://stackoverflow.com/a/1260881>.
Christoph Groth's avatar
Christoph Groth committed
274
        return (isinstance(member, types.MethodType) and
Joseph Weston's avatar
Joseph Weston committed
275
276
277
                member.__self__ is not None and
                not issubclass(member.__self__.__class__, type) and
                member.__self__.__class__ is not type)
Christoph Groth's avatar
Christoph Groth committed
278

279
280
281
282
283
284
285
    def format_args(self):
        args = super(BoundMethodDocumenter, self).format_args()
        left, sep, right = args.partition('self, ')
        if left.endswith('('):
            args = left + right
        return args

Christoph Groth's avatar
Christoph Groth committed
286
287
def setup(app):
    app.add_autodocumenter(BoundMethodDocumenter)
288
289


290
291
292
293
# By default linkcheck only tries once, but experience has shown us that this test is
# very non-specific for detecting dead links. Trying a few times should significantly
# lower the probability of false positives.
linkcheck_retries = 5
294
295
296
# Some websites (particularly IoP) take a long time to respond. The combination of
# this timeout and the retries should make this check sufficiently specific.
linkcheck_timeout = 10
297
298
299
300
301

nitpick_ignore = [('py:class', 'Warning'), ('py:class', 'Exception'),
                  ('py:class', 'object'), ('py:class', 'tuple'),
                  ('py:class', 'kwant.operator._LocalOperator'),
                  ('py:class', 'numpy.ndarray'),
302
303
                  ('py:class', 'kwant.solvers.common.BlockResult'),
                  ('py:class', 'kwant.builder._FinalizedBuilderMixin')]
304
305
306
307


# Use custom MathJax CDN, as cdn.mathjax.org will soon shut down
mathjax_path = "https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.0/MathJax.js?config=TeX-AMS-MML_HTMLorMML"
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330


# -- Make Sphinx insert source code links --------------------------------------
def linkcode_resolve(domain, info):
    def find_source():
        # try to find the file and line number, based on code from numpy:
        # https://github.com/numpy/numpy/blob/master/doc/source/conf.py#L286
        obj = sys.modules[info['module']]
        for part in info['fullname'].split('.'):
            obj = getattr(obj, part)
        import inspect
        fn = inspect.getsourcefile(obj)
        fn = os.path.relpath(fn, start=os.path.dirname(kwant.__file__))
        source, lineno = inspect.getsourcelines(obj)
        return fn, lineno, lineno + len(source) - 1

    if domain != 'py' or not info['module']:
        return None
    try:
        filename = 'kwant/%s#L%d-%d' % find_source()
    except Exception:
        filename = info['module'].replace('.', '/') + '.py'

331
332
333
334
335
336
337
338
339
340
341
342
343
344
    # The following relies on the documented format of kwant.__version__.
    rel = release.rstrip('.dirty')
    if '.dev' in rel:
        try:
            refname = rel[rel.index('+g') + 2:]
        except ValueError:
            return
    else:
        refname = 'v' + rel

    templ = os.environ.get(
        "SOURCE_LINK_TEMPLATE",
        "https://gitlab.kwant-project.org/kwant/kwant/blob/$r/$f")
    return string.Template(templ).safe_substitute(r=refname, f=filename)