Debian Codegraph @

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