Debian Codegraph @

python/doc/source/conf.py

raw ◀ ▶
1 Debian patch touch this file
1 #!/usr/bin/env python3
2 # -*- coding: utf-8 -*-
3 #
4 # DOLFIN documentation build configuration file, created by
5 # sphinx-quickstart on Sat Jul 8 11:30:06 2017.
6 #
7 # This file is execfile()d with the current directory set to its
8 # containing dir.
9 #
10 # Note that not all possible configuration values are present in this
11 # autogenerated file.
12 #
13 # All configuration values have a default; values that are commented out
14 # serve to show the default.
15
16 # If extensions (or modules to document with autodoc) are in another directory,
17 # add these directories to sys.path here. If the directory is relative to the
18 # documentation root, use os.path.abspath to make it absolute, like shown here.
19 #
20 # import os
21 # import sys
22 # sys.path.insert(0, os.path.abspath('.'))
23
24 # Copy demo files into doc source tree and process with pylit
25 import os
26 import sys
27 sys.path.append(os.getcwd())
28 import rstprocess
29 rstprocess.process()
30
31 # -- General configuration ------------------------------------------------
32
33 # If your documentation needs a minimal Sphinx version, state it here.
34 #
35 # needs_sphinx = '1.0'
36
37 # Add any Sphinx extension module names here, as strings. They can be
38 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
39 # ones.
40 extensions = ['sphinx.ext.autodoc',
41 'sphinx.ext.autosummary',
42 'sphinx.ext.mathjax',
43 'sphinx.ext.viewcode']
44
45 # Add any paths that contain templates here, relative to this directory.
46 templates_path = ['_templates']
47
•48 mathjax_path = 'file:///usr/share/javascript/mathjax/MathJax.js?config=TeX-AMS-MML_HTMLorMML'
49
50 # The suffix(es) of source filenames.
51 # You can specify multiple suffix as a list of string:
52 #
53 # source_suffix = ['.rst', '.md']
54 source_suffix = '.rst'
55
56 # The master toctree document.
57 master_doc = 'index'
58
59 # General information about the project.
60 project = 'DOLFIN'
61 copyright = '2017, FEniCS Project'
62 author = 'FEniCS Project'
63
64 # The version info for the project you're documenting, acts as replacement for
65 # |version| and |release|, also used in various other places throughout the
66 # built documents.
67 #
68 # The short X.Y version.
69 version = ''
70 # The full version, including alpha/beta/rc tags.
71 release = ''
72
73 # The language for content autogenerated by Sphinx. Refer to documentation
74 # for a list of supported languages.
75 #
76 # This is also used if you do content translation via gettext catalogs.
77 # Usually you set "language" from the command line for these cases.
78 language = None
79
80 # List of patterns, relative to source directory, that match files and
81 # directories to ignore when looking for source files.
82 # This patterns also effect to html_static_path and html_extra_path
83 exclude_patterns = []
84
85 # The name of the Pygments (syntax highlighting) style to use.
86 pygments_style = 'sphinx'
87
88 # If true, `todo` and `todoList` produce output, else they produce nothing.
89 todo_include_todos = False
90
91
92 # -- Options for HTML output ----------------------------------------------
93
94 # The theme to use for HTML and HTML Help pages. See the documentation for
95 # a list of builtin themes.
96 #
97 #html_theme = 'alabaster'
98 html_theme = "sphinx_rtd_theme"
99
100 # Theme options are theme-specific and customize the look and feel of a theme
101 # further. For a list of options available for each theme, see the
102 # documentation.
103 #
104 # html_theme_options = {}
105
106 # Add any paths that contain custom static files (such as style sheets) here,
107 # relative to this directory. They are copied after the builtin static files,
108 # so a file named "default.css" will overwrite the builtin "default.css".
109 html_static_path = ['_static']
110
111 # Custom sidebar templates, must be a dictionary that maps document names
112 # to template names.
113 #
114 # This is required for the alabaster theme
115 # refs: http://alabaster.readthedocs.io/en/latest/installation.html#sidebars
116 html_sidebars = {
117 '**': [
118 'about.html',
119 'navigation.html',
120 'relations.html', # needs 'show_related': True theme option to display
121 'searchbox.html',
122 'donate.html',
123 ]
124 }
125
126
127 # -- Options for HTMLHelp output ------------------------------------------
128
129 # Output file base name for HTML help builder.
130 htmlhelp_basename = 'DOLFINdoc'
131
132
133 # -- Options for LaTeX output ---------------------------------------------
134
135 latex_elements = {
136 # The paper size ('letterpaper' or 'a4paper').
137 #
138 # 'papersize': 'letterpaper',
139
140 # The font size ('10pt', '11pt' or '12pt').
141 #
142 # 'pointsize': '10pt',
143
144 # Additional stuff for the LaTeX preamble.
145 #
146 # 'preamble': '',
147
148 # Latex figure (float) alignment
149 #
150 # 'figure_align': 'htbp',
151 }
152
153 # Grouping the document tree into LaTeX files. List of tuples
154 # (source start file, target name, title,
155 # author, documentclass [howto, manual, or own class]).
156 latex_documents = [
157 (master_doc, 'DOLFIN.tex', 'DOLFIN Documentation',
158 'FEniCS Project', 'manual'),
159 ]
160
161
162 # -- Options for manual page output ---------------------------------------
163
164 # One entry per manual page. List of tuples
165 # (source start file, name, description, authors, manual section).
166 man_pages = [
167 (master_doc, 'dolfin', 'DOLFIN Documentation',
168 [author], 1)
169 ]
170
171
172 # -- Options for Texinfo output -------------------------------------------
173
174 # Grouping the document tree into Texinfo files. List of tuples
175 # (source start file, target name, title, author,
176 # dir menu entry, description, category)
177 texinfo_documents = [
178 (master_doc, 'DOLFIN', 'DOLFIN Documentation',
179 author, 'DOLFIN', 'One line description of project.',
180 'Miscellaneous'),
181 ]
182
183 autodoc_default_flags = ['members', 'show-inheritance']
184 autosummary_generate = True