|
22 | 22 | # sys.path.insert(0, os.path.abspath('.')) |
23 | 23 |
|
24 | 24 | import sphinx_rtd_theme |
| 25 | + |
25 | 26 | html_theme = "sphinx_rtd_theme" |
26 | 27 | html_theme_path = [sphinx_rtd_theme.get_html_theme_path()] |
27 | 28 |
|
28 | 29 | # Convert package README.md to intro.rst to include in index.rst for docs |
29 | 30 | try: |
30 | 31 | import pypandoc |
31 | | - long_description = pypandoc.convert_file('../README.md', 'rst', |
32 | | - outputfile='intro.rst') |
33 | | -except(ImportError): |
34 | | - print('Install pypandoc to convert README.md to intro.rst') |
| 32 | + |
| 33 | + long_description = pypandoc.convert_file("../README.md", "rst", outputfile="intro.rst") |
| 34 | +except (ImportError): |
| 35 | + print("Install pypandoc to convert README.md to intro.rst") |
35 | 36 |
|
36 | 37 |
|
37 | 38 | # -- General configuration ------------------------------------------------ |
|
44 | 45 | # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom |
45 | 46 | # ones. |
46 | 47 | extensions = [ |
47 | | - 'sphinx.ext.autodoc', |
48 | | - 'sphinx.ext.todo', |
49 | | - 'sphinx.ext.coverage', |
50 | | - 'sphinx.ext.mathjax', |
51 | | - 'sphinx.ext.napoleon' |
| 48 | + "sphinx.ext.autodoc", |
| 49 | + "sphinx.ext.todo", |
| 50 | + "sphinx.ext.coverage", |
| 51 | + "sphinx.ext.mathjax", |
| 52 | + "sphinx.ext.napoleon", |
52 | 53 | ] |
53 | 54 |
|
54 | 55 | # Add any paths that contain templates here, relative to this directory. |
55 | | -templates_path = ['_templates'] |
| 56 | +templates_path = ["_templates"] |
56 | 57 |
|
57 | 58 | # for parsing markdown files |
58 | | -source_parsers = { |
59 | | - '.md': 'recommonmark.parser.CommonMarkParser', |
60 | | -} |
| 59 | +source_parsers = {".md": "recommonmark.parser.CommonMarkParser"} |
61 | 60 |
|
62 | 61 | # The suffix(es) of source filenames. |
63 | 62 | # You can specify multiple suffix as a list of string: |
64 | 63 | # |
65 | | -source_suffix = ['.rst', '.md'] |
| 64 | +source_suffix = [".rst", ".md"] |
66 | 65 |
|
67 | 66 | # The master toctree document. |
68 | | -master_doc = 'index' |
| 67 | +master_doc = "index" |
69 | 68 |
|
70 | 69 | # General information about the project. |
71 | | -project = 'lifetimes' |
72 | | -copyright = '2015, Cameron Davidson-Pilon' |
73 | | -author = 'Cameron Davidson-Pilon' |
| 70 | +project = "lifetimes" |
| 71 | +copyright = "2015, Cameron Davidson-Pilon" |
| 72 | +author = "Cameron Davidson-Pilon" |
74 | 73 |
|
75 | 74 | # The version info for the project you're documenting, acts as replacement for |
76 | 75 | # |version| and |release|, also used in various other places throughout the |
77 | 76 | # built documents. |
78 | 77 | # |
79 | 78 | # The short X.Y version. |
80 | | -version = '0.11.0' |
| 79 | +version = "0.11.1" |
81 | 80 | # The full version, including alpha/beta/rc tags. |
82 | 81 | release = version |
83 | 82 |
|
|
91 | 90 | # List of patterns, relative to source directory, that match files and |
92 | 91 | # directories to ignore when looking for source files. |
93 | 92 | # This patterns also effect to html_static_path and html_extra_path |
94 | | -exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store'] |
| 93 | +exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"] |
95 | 94 |
|
96 | 95 | # The name of the Pygments (syntax highlighting) style to use. |
97 | | -pygments_style = 'sphinx' |
| 96 | +pygments_style = "sphinx" |
98 | 97 |
|
99 | 98 | # If true, `todo` and `todoList` produce output, else they produce nothing. |
100 | 99 | todo_include_todos = True |
|
117 | 116 | # Add any paths that contain custom static files (such as style sheets) here, |
118 | 117 | # relative to this directory. They are copied after the builtin static files, |
119 | 118 | # so a file named "default.css" will overwrite the builtin "default.css". |
120 | | -html_static_path = ['_static'] |
| 119 | +html_static_path = ["_static"] |
121 | 120 |
|
122 | 121 | # -- Napoleon settings ---------------------------------------------------- |
123 | 122 | napoleon_google_docstring = True |
|
137 | 136 | # -- Options for HTMLHelp output ------------------------------------------ |
138 | 137 |
|
139 | 138 | # Output file base name for HTML help builder. |
140 | | -htmlhelp_basename = 'lifetimesdoc' |
| 139 | +htmlhelp_basename = "lifetimesdoc" |
141 | 140 |
|
142 | 141 |
|
143 | 142 | # -- Options for LaTeX output --------------------------------------------- |
|
146 | 145 | # The paper size ('letterpaper' or 'a4paper'). |
147 | 146 | # |
148 | 147 | # 'papersize': 'letterpaper', |
149 | | - |
150 | 148 | # The font size ('10pt', '11pt' or '12pt'). |
151 | 149 | # |
152 | 150 | # 'pointsize': '10pt', |
153 | | - |
154 | 151 | # Additional stuff for the LaTeX preamble. |
155 | 152 | # |
156 | 153 | # 'preamble': '', |
157 | | - |
158 | 154 | # Latex figure (float) alignment |
159 | 155 | # |
160 | 156 | # 'figure_align': 'htbp', |
|
163 | 159 | # Grouping the document tree into LaTeX files. List of tuples |
164 | 160 | # (source start file, target name, title, |
165 | 161 | # author, documentclass [howto, manual, or own class]). |
166 | | -latex_documents = [ |
167 | | - (master_doc, 'lifetimes.tex', 'lifetimes Documentation', |
168 | | - 'Cameron Davidson-Pilon', 'manual'), |
169 | | -] |
| 162 | +latex_documents = [(master_doc, "lifetimes.tex", "lifetimes Documentation", "Cameron Davidson-Pilon", "manual")] |
170 | 163 |
|
171 | 164 |
|
172 | 165 | # -- Options for manual page output --------------------------------------- |
173 | 166 |
|
174 | 167 | # One entry per manual page. List of tuples |
175 | 168 | # (source start file, name, description, authors, manual section). |
176 | | -man_pages = [ |
177 | | - (master_doc, 'lifetimes', 'lifetimes Documentation', |
178 | | - [author], 1) |
179 | | -] |
| 169 | +man_pages = [(master_doc, "lifetimes", "lifetimes Documentation", [author], 1)] |
180 | 170 |
|
181 | 171 |
|
182 | 172 | # -- Options for Texinfo output ------------------------------------------- |
|
185 | 175 | # (source start file, target name, title, author, |
186 | 176 | # dir menu entry, description, category) |
187 | 177 | texinfo_documents = [ |
188 | | - (master_doc, 'lifetimes', 'lifetimes Documentation', |
189 | | - author, 'lifetimes', 'One line description of project.', |
190 | | - 'Miscellaneous'), |
| 178 | + ( |
| 179 | + master_doc, |
| 180 | + "lifetimes", |
| 181 | + "lifetimes Documentation", |
| 182 | + author, |
| 183 | + "lifetimes", |
| 184 | + "One line description of project.", |
| 185 | + "Miscellaneous", |
| 186 | + ) |
191 | 187 | ] |
0 commit comments