|
1 | | -# -*- coding: utf-8 -*- |
2 | 1 | # |
3 | 2 | # Configuration file for the Sphinx documentation builder. |
4 | 3 | # |
|
15 | 14 | import os |
16 | 15 | import sys |
17 | 16 |
|
18 | | -sys.path.insert(0, os.path.abspath('..')) |
| 17 | +sys.path.insert(0, os.path.abspath("..")) |
19 | 18 |
|
20 | 19 |
|
21 | 20 | # -- Project information ----------------------------------------------------- |
22 | 21 |
|
23 | | -project = 'fluent_compiler' |
24 | | -copyright = '2019, Luke Plant' |
25 | | -author = 'Luke Plant' |
| 22 | +project = "fluent_compiler" |
| 23 | +copyright = "2019, Luke Plant" |
| 24 | +author = "Luke Plant" |
26 | 25 |
|
27 | 26 | # The short X.Y version |
28 | | -version = '0.3' |
| 27 | +version = "0.3" |
29 | 28 | # The full version, including alpha/beta/rc tags |
30 | | -release = '0.3' |
| 29 | +release = "0.3" |
31 | 30 |
|
32 | 31 |
|
33 | 32 | # -- General configuration --------------------------------------------------- |
|
40 | 39 | # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom |
41 | 40 | # ones. |
42 | 41 | extensions = [ |
43 | | - 'sphinx.ext.intersphinx', |
44 | | - 'sphinx.ext.viewcode', |
| 42 | + "sphinx.ext.intersphinx", |
| 43 | + "sphinx.ext.viewcode", |
45 | 44 | ] |
46 | 45 |
|
47 | 46 | # Add any paths that contain templates here, relative to this directory. |
48 | | -templates_path = ['_templates'] |
| 47 | +templates_path = ["_templates"] |
49 | 48 |
|
50 | 49 | # The suffix(es) of source filenames. |
51 | 50 | # You can specify multiple suffix as a list of string: |
52 | 51 | # |
53 | 52 | # source_suffix = ['.rst', '.md'] |
54 | | -source_suffix = '.rst' |
| 53 | +source_suffix = ".rst" |
55 | 54 |
|
56 | 55 | # The master toctree document. |
57 | | -master_doc = 'index' |
| 56 | +master_doc = "index" |
58 | 57 |
|
59 | 58 | # The language for content autogenerated by Sphinx. Refer to documentation |
60 | 59 | # for a list of supported languages. |
|
66 | 65 | # List of patterns, relative to source directory, that match files and |
67 | 66 | # directories to ignore when looking for source files. |
68 | 67 | # This pattern also affects html_static_path and html_extra_path. |
69 | | -exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store'] |
| 68 | +exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"] |
70 | 69 |
|
71 | 70 | # The name of the Pygments (syntax highlighting) style to use. |
72 | 71 | pygments_style = None |
|
77 | 76 | # The theme to use for HTML and HTML Help pages. See the documentation for |
78 | 77 | # a list of builtin themes. |
79 | 78 | # |
80 | | -html_theme = 'default' |
| 79 | +html_theme = "default" |
81 | 80 |
|
82 | 81 | # Theme options are theme-specific and customize the look and feel of a theme |
83 | 82 | # further. For a list of options available for each theme, see the |
|
88 | 87 | # Add any paths that contain custom static files (such as style sheets) here, |
89 | 88 | # relative to this directory. They are copied after the builtin static files, |
90 | 89 | # so a file named "default.css" will overwrite the builtin "default.css". |
91 | | -html_static_path = ['_static'] |
| 90 | +html_static_path = ["_static"] |
92 | 91 |
|
93 | 92 | # Custom sidebar templates, must be a dictionary that maps document names |
94 | 93 | # to template names. |
|
104 | 103 | # -- Options for HTMLHelp output --------------------------------------------- |
105 | 104 |
|
106 | 105 | # Output file base name for HTML help builder. |
107 | | -htmlhelp_basename = 'fluentcompilerdoc' |
| 106 | +htmlhelp_basename = "fluentcompilerdoc" |
108 | 107 |
|
109 | 108 |
|
110 | 109 | # -- Options for LaTeX output ------------------------------------------------ |
|
113 | 112 | # The paper size ('letterpaper' or 'a4paper'). |
114 | 113 | # |
115 | 114 | # 'papersize': 'letterpaper', |
116 | | - |
117 | 115 | # The font size ('10pt', '11pt' or '12pt'). |
118 | 116 | # |
119 | 117 | # 'pointsize': '10pt', |
120 | | - |
121 | 118 | # Additional stuff for the LaTeX preamble. |
122 | 119 | # |
123 | 120 | # 'preamble': '', |
124 | | - |
125 | 121 | # Latex figure (float) alignment |
126 | 122 | # |
127 | 123 | # 'figure_align': 'htbp', |
|
131 | 127 | # (source start file, target name, title, |
132 | 128 | # author, documentclass [howto, manual, or own class]). |
133 | 129 | latex_documents = [ |
134 | | - (master_doc, 'fluentcompiler.tex', 'fluent_compiler Documentation', |
135 | | - 'Luke Plant', 'manual'), |
| 130 | + ( |
| 131 | + master_doc, |
| 132 | + "fluentcompiler.tex", |
| 133 | + "fluent_compiler Documentation", |
| 134 | + "Luke Plant", |
| 135 | + "manual", |
| 136 | + ), |
136 | 137 | ] |
137 | 138 |
|
138 | 139 |
|
139 | 140 | # -- Options for manual page output ------------------------------------------ |
140 | 141 |
|
141 | 142 | # One entry per manual page. List of tuples |
142 | 143 | # (source start file, name, description, authors, manual section). |
143 | | -man_pages = [ |
144 | | - (master_doc, 'fluentcompiler', 'fluent_compiler Documentation', |
145 | | - [author], 1) |
146 | | -] |
| 144 | +man_pages = [(master_doc, "fluentcompiler", "fluent_compiler Documentation", [author], 1)] |
147 | 145 |
|
148 | 146 |
|
149 | 147 | # -- Options for Texinfo output ---------------------------------------------- |
|
152 | 150 | # (source start file, target name, title, author, |
153 | 151 | # dir menu entry, description, category) |
154 | 152 | texinfo_documents = [ |
155 | | - (master_doc, 'fluentcompiler', 'fluent_compiler Documentation', |
156 | | - author, 'fluentcompiler', 'One line description of project.', |
157 | | - 'Miscellaneous'), |
| 153 | + ( |
| 154 | + master_doc, |
| 155 | + "fluentcompiler", |
| 156 | + "fluent_compiler Documentation", |
| 157 | + author, |
| 158 | + "fluentcompiler", |
| 159 | + "One line description of project.", |
| 160 | + "Miscellaneous", |
| 161 | + ), |
158 | 162 | ] |
159 | 163 |
|
160 | 164 |
|
|
173 | 177 | # epub_uid = '' |
174 | 178 |
|
175 | 179 | # A list of files that should not be packed into the epub file. |
176 | | -epub_exclude_files = ['search.html'] |
| 180 | +epub_exclude_files = ["search.html"] |
177 | 181 |
|
178 | 182 |
|
179 | 183 | # -- Extension configuration ------------------------------------------------- |
180 | 184 |
|
181 | 185 | # -- Options for intersphinx extension --------------------------------------- |
182 | 186 |
|
183 | 187 | # Example configuration for intersphinx: refer to the Python standard library. |
184 | | -intersphinx_mapping = {'python': ('https://docs.python.org/3', None)} |
| 188 | +intersphinx_mapping = {"python": ("https://docs.python.org/3", None)} |
0 commit comments