|
11 | 11 | # |
12 | 12 | # All configuration values have a default; values that are commented out |
13 | 13 | # serve to show the default. |
14 | | - |
15 | 14 | # If extensions (or modules to document with autodoc) are in another directory, |
16 | 15 | # add these directories to sys.path here. If the directory is relative to the |
17 | 16 | # documentation root, use os.path.abspath to make it absolute, like shown here. |
18 | 17 | # |
19 | 18 | import os |
20 | 19 | import sys |
21 | | -sys.path.insert(0, os.path.abspath('../')) |
22 | 20 |
|
23 | | -sys.path.append(os.path.abspath('.')) |
| 21 | +sys.path.insert(0, os.path.abspath("../")) |
| 22 | + |
| 23 | +sys.path.append(os.path.abspath(".")) |
24 | 24 |
|
25 | 25 | # -- General configuration ------------------------------------------------ |
26 | 26 |
|
|
31 | 31 | # Add any Sphinx extension module names here, as strings. They can be |
32 | 32 | # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom |
33 | 33 | # ones. |
34 | | -extensions = ['sphinx.ext.autodoc', |
35 | | - 'sphinx.ext.viewcode', |
36 | | - 'sphinx.ext.autosummary', |
37 | | - 'sphinx.ext.napoleon'] |
| 34 | +extensions = [ |
| 35 | + "sphinx.ext.autodoc", |
| 36 | + "sphinx.ext.viewcode", |
| 37 | + "sphinx.ext.autosummary", |
| 38 | + "sphinx.ext.napoleon", |
| 39 | +] |
38 | 40 |
|
39 | 41 |
|
40 | 42 | # Add any paths that contain templates here, relative to this directory. |
41 | | -templates_path = ['_templates'] |
| 43 | +templates_path = ["_templates"] |
42 | 44 |
|
43 | 45 | # The suffix(es) of source filenames. |
44 | 46 | # You can specify multiple suffix as a list of string: |
45 | 47 | # |
46 | 48 | # source_suffix = ['.rst', '.md'] |
47 | | -source_suffix = '.rst' |
| 49 | +source_suffix = ".rst" |
48 | 50 |
|
49 | 51 | # The master toctree document. |
50 | | -master_doc = 'index' |
| 52 | +master_doc = "index" |
51 | 53 |
|
52 | 54 | # General information about the project. |
53 | | -project = u'readit' |
54 | | -copyright = u'2018, projectreadit organization' |
55 | | -author = u'projectreadit organization' |
| 55 | +project = u"readit" |
| 56 | +copyright = u"2018, projectreadit organization" |
| 57 | +author = u"projectreadit organization" |
56 | 58 |
|
57 | 59 | # The version info for the project you're documenting, acts as replacement for |
58 | 60 | # |version| and |release|, also used in various other places throughout the |
59 | 61 | # built documents. |
60 | 62 | # |
61 | 63 | # The short X.Y version. |
62 | | -version = u'' |
| 64 | +version = u"" |
63 | 65 | # The full version, including alpha/beta/rc tags. |
64 | | -release = u'v0.2' |
| 66 | +release = u"v0.2" |
65 | 67 |
|
66 | 68 | # The language for content autogenerated by Sphinx. Refer to documentation |
67 | 69 | # for a list of supported languages. |
|
73 | 75 | # List of patterns, relative to source directory, that match files and |
74 | 76 | # directories to ignore when looking for source files. |
75 | 77 | # This patterns also effect to html_static_path and html_extra_path |
76 | | -exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store'] |
| 78 | +exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"] |
77 | 79 |
|
78 | 80 | # The name of the Pygments (syntax highlighting) style to use. |
79 | | -pygments_style = 'sphinx' |
| 81 | +pygments_style = "sphinx" |
80 | 82 |
|
81 | 83 | # If true, `todo` and `todoList` produce output, else they produce nothing. |
82 | 84 | todo_include_todos = False |
|
87 | 89 | # The theme to use for HTML and HTML Help pages. See the documentation for |
88 | 90 | # a list of builtin themes. |
89 | 91 | # |
90 | | -html_theme = 'sphinx_rtd_theme' |
| 92 | +html_theme = "sphinx_rtd_theme" |
91 | 93 |
|
92 | 94 | # Theme options are theme-specific and customize the look and feel of a theme |
93 | 95 | # further. For a list of options available for each theme, see the |
|
98 | 100 | # Add any paths that contain custom static files (such as style sheets) here, |
99 | 101 | # relative to this directory. They are copied after the builtin static files, |
100 | 102 | # so a file named "default.css" will overwrite the builtin "default.css". |
101 | | -html_static_path = ['_static'] |
| 103 | +html_static_path = ["_static"] |
102 | 104 |
|
103 | 105 | # Custom sidebar templates, must be a dictionary that maps document names |
104 | 106 | # to template names. |
105 | 107 | # |
106 | 108 | # This is required for the alabaster theme |
107 | 109 | # refs: http://alabaster.readthedocs.io/en/latest/installation.html#sidebars |
108 | 110 | 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', |
| 111 | + "**": [ |
| 112 | + "about.html", |
| 113 | + "navigation.html", |
| 114 | + "relations.html", # needs 'show_related': True theme option to display |
| 115 | + "searchbox.html", |
| 116 | + "donate.html", |
115 | 117 | ] |
116 | 118 | } |
117 | 119 |
|
118 | 120 |
|
119 | | - |
120 | | - |
121 | 121 | # -- Options for HTMLHelp output ------------------------------------------ |
122 | 122 |
|
123 | 123 | # Output file base name for HTML help builder. |
124 | | -htmlhelp_basename = 'readitdoc' |
| 124 | +htmlhelp_basename = "readitdoc" |
125 | 125 |
|
126 | 126 |
|
127 | 127 | # -- Options for LaTeX output --------------------------------------------- |
|
130 | 130 | # The paper size ('letterpaper' or 'a4paper'). |
131 | 131 | # |
132 | 132 | # 'papersize': 'letterpaper', |
133 | | - |
134 | 133 | # The font size ('10pt', '11pt' or '12pt'). |
135 | 134 | # |
136 | 135 | # 'pointsize': '10pt', |
137 | | - |
138 | 136 | # Additional stuff for the LaTeX preamble. |
139 | 137 | # |
140 | 138 | # 'preamble': '', |
141 | | - |
142 | 139 | # Latex figure (float) alignment |
143 | 140 | # |
144 | 141 | # 'figure_align': 'htbp', |
|
148 | 145 | # (source start file, target name, title, |
149 | 146 | # author, documentclass [howto, manual, or own class]). |
150 | 147 | latex_documents = [ |
151 | | - (master_doc, 'readit.tex', u'readit Documentation', |
152 | | - u'projectreadit organization', 'manual'), |
| 148 | + (master_doc, "readit.tex", u"readit Documentation", u"projectreadit organization", "manual"), |
153 | 149 | ] |
154 | 150 |
|
155 | 151 |
|
156 | 152 | # -- Options for manual page output --------------------------------------- |
157 | 153 |
|
158 | 154 | # One entry per manual page. List of tuples |
159 | 155 | # (source start file, name, description, authors, manual section). |
160 | | -man_pages = [ |
161 | | - (master_doc, 'readit', u'readit Documentation', |
162 | | - [author], 1) |
163 | | -] |
| 156 | +man_pages = [(master_doc, "readit", u"readit Documentation", [author], 1)] |
164 | 157 |
|
165 | 158 |
|
166 | 159 | # -- Options for Texinfo output ------------------------------------------- |
|
169 | 162 | # (source start file, target name, title, author, |
170 | 163 | # dir menu entry, description, category) |
171 | 164 | texinfo_documents = [ |
172 | | - (master_doc, 'readit', u'readit Documentation', |
173 | | - author, 'readit', 'One line description of project.', |
174 | | - 'Miscellaneous'), |
| 165 | + ( |
| 166 | + master_doc, |
| 167 | + "readit", |
| 168 | + u"readit Documentation", |
| 169 | + author, |
| 170 | + "readit", |
| 171 | + "One line description of project.", |
| 172 | + "Miscellaneous", |
| 173 | + ), |
175 | 174 | ] |
176 | | - |
177 | | - |
178 | | - |
0 commit comments