Debian Codegraph @

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