Debian Codegraph @

python/doc/source/conf.py

raw ◀ ▶
Source reconstructed at patch state 0 of 1 — not the installed (fully patched) source.
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 # The suffix(es) of source filenames.
49 # You can specify multiple suffix as a list of string:
50 #
51 # source_suffix = ['.rst', '.md']
52 source_suffix = '.rst'
53
54 # The master toctree document.
55 master_doc = 'index'
56
57 # General information about the project.
58 project = 'DOLFIN'
59 copyright = '2017, FEniCS Project'
60 author = 'FEniCS Project'
61
62 # The version info for the project you're documenting, acts as replacement for
63 # |version| and |release|, also used in various other places throughout the
64 # built documents.
65 #
66 # The short X.Y version.
67 version = ''
68 # The full version, including alpha/beta/rc tags.
69 release = ''
70
71 # The language for content autogenerated by Sphinx. Refer to documentation
72 # for a list of supported languages.
73 #
74 # This is also used if you do content translation via gettext catalogs.
75 # Usually you set "language" from the command line for these cases.
76 language = None
77
78 # List of patterns, relative to source directory, that match files and
79 # directories to ignore when looking for source files.
80 # This patterns also effect to html_static_path and html_extra_path
81 exclude_patterns = []
82
83 # The name of the Pygments (syntax highlighting) style to use.
84 pygments_style = 'sphinx'
85
86 # If true, `todo` and `todoList` produce output, else they produce nothing.
87 todo_include_todos = False
88
89
90 # -- Options for HTML output ----------------------------------------------
91
92 # The theme to use for HTML and HTML Help pages. See the documentation for
93 # a list of builtin themes.
94 #
95 #html_theme = 'alabaster'
96 html_theme = "sphinx_rtd_theme"
97
98 # Theme options are theme-specific and customize the look and feel of a theme
99 # further. For a list of options available for each theme, see the
100 # documentation.
101 #
102 # html_theme_options = {}
103
104 # Add any paths that contain custom static files (such as style sheets) here,
105 # relative to this directory. They are copied after the builtin static files,
106 # so a file named "default.css" will overwrite the builtin "default.css".
107 html_static_path = ['_static']
108
109 # Custom sidebar templates, must be a dictionary that maps document names
110 # to template names.
111 #
112 # This is required for the alabaster theme
113 # refs: http://alabaster.readthedocs.io/en/latest/installation.html#sidebars
114 html_sidebars = {
115 '**': [
116 'about.html',
117 'navigation.html',
118 'relations.html', # needs 'show_related': True theme option to display
119 'searchbox.html',
120 'donate.html',
121 ]
122 }
123
124
125 # -- Options for HTMLHelp output ------------------------------------------
126
127 # Output file base name for HTML help builder.
128 htmlhelp_basename = 'DOLFINdoc'
129
130
131 # -- Options for LaTeX output ---------------------------------------------
132
133 latex_elements = {
134 # The paper size ('letterpaper' or 'a4paper').
135 #
136 # 'papersize': 'letterpaper',
137
138 # The font size ('10pt', '11pt' or '12pt').
139 #
140 # 'pointsize': '10pt',
141
142 # Additional stuff for the LaTeX preamble.
143 #
144 # 'preamble': '',
145
146 # Latex figure (float) alignment
147 #
148 # 'figure_align': 'htbp',
149 }
150
151 # Grouping the document tree into LaTeX files. List of tuples
152 # (source start file, target name, title,
153 # author, documentclass [howto, manual, or own class]).
154 latex_documents = [
155 (master_doc, 'DOLFIN.tex', 'DOLFIN Documentation',
156 'FEniCS Project', 'manual'),
157 ]
158
159
160 # -- Options for manual page output ---------------------------------------
161
162 # One entry per manual page. List of tuples
163 # (source start file, name, description, authors, manual section).
164 man_pages = [
165 (master_doc, 'dolfin', 'DOLFIN Documentation',
166 [author], 1)
167 ]
168
169
170 # -- Options for Texinfo output -------------------------------------------
171
172 # Grouping the document tree into Texinfo files. List of tuples
173 # (source start file, target name, title, author,
174 # dir menu entry, description, category)
175 texinfo_documents = [
176 (master_doc, 'DOLFIN', 'DOLFIN Documentation',
177 author, 'DOLFIN', 'One line description of project.',
178 'Miscellaneous'),
179 ]
180
181 autodoc_default_flags = ['members', 'show-inheritance']
182 autosummary_generate = True