Debian Codegraph @

docs/source/conf.py

raw
1 #!/usr/bin/env python3
2 # -*- coding: utf-8 -*-
3 #
4 # Compyle documentation build configuration file, created by
5 # sphinx-quickstart on Sun Dec 2 14:26:18 2018.
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 from os.path import join
22 # import sys
23 # sys.path.insert(0, os.path.abspath('.'))
24
25
26 # -- General configuration ------------------------------------------------
27
28 # If your documentation needs a minimal Sphinx version, state it here.
29 #
30 # needs_sphinx = '1.0'
31
32 # Add any Sphinx extension module names here, as strings. They can be
33 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
34 # ones.
35 extensions = ['sphinx.ext.autodoc',
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 = 'Compyle'
53 copyright = '2018-2021, PySPH Developers'
54 author = 'PySPH Developers'
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 version info for the project you're documenting, acts as replacement for
61 # |version| and |release|, also used in various other places throughout the
62 # built documents.
63 #
64 _d = {}
65 fname = join(os.pardir, os.pardir, 'compyle', '__init__.py')
66 exec(compile(open(fname).read(), fname, 'exec'), _d)
67 version = release = _d['__version__']
68
69 # The language for content autogenerated by Sphinx. Refer to documentation
70 # for a list of supported languages.
71 #
72 # This is also used if you do content translation via gettext catalogs.
73 # Usually you set "language" from the command line for these cases.
74 language = None
75
76 # List of patterns, relative to source directory, that match files and
77 # directories to ignore when looking for source files.
78 # This patterns also effect to html_static_path and html_extra_path
79 exclude_patterns = []
80
81 # The name of the Pygments (syntax highlighting) style to use.
82 pygments_style = 'sphinx'
83
84 # If true, `todo` and `todoList` produce output, else they produce nothing.
85 todo_include_todos = False
86
87
88 # -- Options for HTML output ----------------------------------------------
89
90 # The theme to use for HTML and HTML Help pages. See the documentation for
91 # a list of builtin themes.
92 #
93 html_theme = 'sphinx_rtd_theme'
94
95 # Theme options are theme-specific and customize the look and feel of a theme
96 # further. For a list of options available for each theme, see the
97 # documentation.
98 #
99 # html_theme_options = {}
100
101 # Add any paths that contain custom static files (such as style sheets) here,
102 # relative to this directory. They are copied after the builtin static files,
103 # so a file named "default.css" will overwrite the builtin "default.css".
104 html_static_path = ['_static']
105
106
107 # -- Options for HTMLHelp output ------------------------------------------
108
109 # Output file base name for HTML help builder.
110 htmlhelp_basename = 'Compyledoc'
111
112
113 # -- Options for LaTeX output ---------------------------------------------
114
115 latex_elements = {
116 # The paper size ('letterpaper' or 'a4paper').
117 #
118 # 'papersize': 'letterpaper',
119
120 # The font size ('10pt', '11pt' or '12pt').
121 #
122 # 'pointsize': '10pt',
123
124 # Additional stuff for the LaTeX preamble.
125 #
126 # 'preamble': '',
127
128 # Latex figure (float) alignment
129 #
130 # 'figure_align': 'htbp',
131 }
132
133 # Grouping the document tree into LaTeX files. List of tuples
134 # (source start file, target name, title,
135 # author, documentclass [howto, manual, or own class]).
136 latex_documents = [
137 (master_doc, 'Compyle.tex', 'Compyle Documentation',
138 'PySPH Developers', 'manual'),
139 ]
140
141
142 # -- Options for manual page output ---------------------------------------
143
144 # One entry per manual page. List of tuples
145 # (source start file, name, description, authors, manual section).
146 man_pages = [
147 (master_doc, 'compyle', 'Compyle Documentation',
148 [author], 1)
149 ]
150
151
152 # -- Options for Texinfo output -------------------------------------------
153
154 # Grouping the document tree into Texinfo files. List of tuples
155 # (source start file, target name, title, author,
156 # dir menu entry, description, category)
157 texinfo_documents = [
158 (master_doc, 'Compyle', 'Compyle Documentation',
159 author, 'Compyle', 'One line description of project.',
160 'Miscellaneous'),
161 ]