|
19 | 19 | # |
20 | 20 | import os |
21 | 21 | import sys |
| 22 | + |
22 | 23 | # So autodoc can import our package |
23 | | -sys.path.insert(0, os.path.abspath('../..')) |
| 24 | +sys.path.insert(0, os.path.abspath("../..")) |
24 | 25 |
|
25 | 26 | # Warn about all references to unknown targets |
26 | 27 | nitpicky = True |
27 | 28 | # Except for these ones, which we expect to point to unknown targets: |
28 | 29 | nitpick_ignore = [ |
29 | 30 | # Format is ("sphinx reference type", "string"), e.g.: |
30 | | - ("py:obj", "bytes-like"), |
| 31 | + ("py:obj", "bytes-like") |
31 | 32 | ] |
32 | 33 |
|
33 | 34 | # -- General configuration ------------------------------------------------ |
|
40 | 41 | # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom |
41 | 42 | # ones. |
42 | 43 | extensions = [ |
43 | | - 'sphinx.ext.autodoc', |
44 | | - 'sphinx.ext.intersphinx', |
45 | | - 'sphinx.ext.coverage', |
46 | | - 'sphinx.ext.napoleon', |
47 | | - 'sphinxcontrib_trio', |
| 44 | + "sphinx.ext.autodoc", |
| 45 | + "sphinx.ext.intersphinx", |
| 46 | + "sphinx.ext.coverage", |
| 47 | + "sphinx.ext.napoleon", |
| 48 | + "sphinxcontrib_trio", |
48 | 49 | ] |
49 | 50 |
|
50 | 51 | intersphinx_mapping = { |
51 | | - "python": ('https://docs.python.org/3', None), |
52 | | - "trio": ('https://trio.readthedocs.io/en/stable', None), |
| 52 | + "python": ("https://docs.python.org/3", None), |
| 53 | + "trio": ("https://trio.readthedocs.io/en/stable", None), |
53 | 54 | } |
54 | 55 |
|
55 | 56 | autodoc_member_order = "bysource" |
|
61 | 62 | # You can specify multiple suffix as a list of string: |
62 | 63 | # |
63 | 64 | # source_suffix = ['.rst', '.md'] |
64 | | -source_suffix = '.rst' |
| 65 | +source_suffix = ".rst" |
65 | 66 |
|
66 | 67 | # The master toctree document. |
67 | | -master_doc = 'index' |
| 68 | +master_doc = "index" |
68 | 69 |
|
69 | 70 | # General information about the project. |
70 | | -project = 'unasync' |
71 | | -copyright = 'The unasync authors' |
72 | | -author = 'The unasync authors' |
| 71 | +project = "unasync" |
| 72 | +copyright = "The unasync authors" |
| 73 | +author = "The unasync authors" |
73 | 74 |
|
74 | 75 | # The version info for the project you're documenting, acts as replacement for |
75 | 76 | # |version| and |release|, also used in various other places throughout the |
76 | 77 | # built documents. |
77 | 78 | # |
78 | 79 | # The short X.Y version. |
79 | 80 | import unasync |
| 81 | + |
80 | 82 | version = unasync.__version__ |
81 | 83 | # The full version, including alpha/beta/rc tags. |
82 | 84 | release = version |
|
94 | 96 | exclude_patterns = [] |
95 | 97 |
|
96 | 98 | # The name of the Pygments (syntax highlighting) style to use. |
97 | | -pygments_style = 'sphinx' |
| 99 | +pygments_style = "sphinx" |
98 | 100 |
|
99 | 101 | # The default language for :: blocks |
100 | | -highlight_language = 'python3' |
| 102 | +highlight_language = "python3" |
101 | 103 |
|
102 | 104 | # If true, `todo` and `todoList` produce output, else they produce nothing. |
103 | 105 | todo_include_todos = False |
|
108 | 110 | # The theme to use for HTML and HTML Help pages. See the documentation for |
109 | 111 | # a list of builtin themes. |
110 | 112 | # |
111 | | -#html_theme = 'alabaster' |
| 113 | +# html_theme = 'alabaster' |
112 | 114 |
|
113 | 115 | # We have to set this ourselves, not only because it's useful for local |
114 | 116 | # testing, but also because if we don't then RTD will throw away our |
115 | 117 | # html_theme_options. |
116 | 118 | import sphinx_rtd_theme |
117 | | -html_theme = 'sphinx_rtd_theme' |
| 119 | + |
| 120 | +html_theme = "sphinx_rtd_theme" |
118 | 121 | html_theme_path = [sphinx_rtd_theme.get_html_theme_path()] |
119 | 122 |
|
120 | 123 | # Theme options are theme-specific and customize the look and feel of a theme |
|
134 | 137 | # Add any paths that contain custom static files (such as style sheets) here, |
135 | 138 | # relative to this directory. They are copied after the builtin static files, |
136 | 139 | # so a file named "default.css" will overwrite the builtin "default.css". |
137 | | -html_static_path = ['_static'] |
| 140 | +html_static_path = ["_static"] |
138 | 141 |
|
139 | 142 |
|
140 | 143 | # -- Options for HTMLHelp output ------------------------------------------ |
141 | 144 |
|
142 | 145 | # Output file base name for HTML help builder. |
143 | | -htmlhelp_basename = 'unasyncdoc' |
| 146 | +htmlhelp_basename = "unasyncdoc" |
144 | 147 |
|
145 | 148 |
|
146 | 149 | # -- Options for LaTeX output --------------------------------------------- |
|
149 | 152 | # The paper size ('letterpaper' or 'a4paper'). |
150 | 153 | # |
151 | 154 | # 'papersize': 'letterpaper', |
152 | | - |
153 | 155 | # The font size ('10pt', '11pt' or '12pt'). |
154 | 156 | # |
155 | 157 | # 'pointsize': '10pt', |
156 | | - |
157 | 158 | # Additional stuff for the LaTeX preamble. |
158 | 159 | # |
159 | 160 | # 'preamble': '', |
160 | | - |
161 | 161 | # Latex figure (float) alignment |
162 | 162 | # |
163 | 163 | # 'figure_align': 'htbp', |
|
166 | 166 | # Grouping the document tree into LaTeX files. List of tuples |
167 | 167 | # (source start file, target name, title, |
168 | 168 | # author, documentclass [howto, manual, or own class]). |
169 | | -latex_documents = [ |
170 | | - (master_doc, 'unasync.tex', 'Trio Documentation', |
171 | | - author, 'manual'), |
172 | | -] |
| 169 | +latex_documents = [(master_doc, "unasync.tex", "Trio Documentation", author, "manual")] |
173 | 170 |
|
174 | 171 |
|
175 | 172 | # -- Options for manual page output --------------------------------------- |
176 | 173 |
|
177 | 174 | # One entry per manual page. List of tuples |
178 | 175 | # (source start file, name, description, authors, manual section). |
179 | | -man_pages = [ |
180 | | - (master_doc, 'unasync', 'unasync Documentation', |
181 | | - [author], 1) |
182 | | -] |
| 176 | +man_pages = [(master_doc, "unasync", "unasync Documentation", [author], 1)] |
183 | 177 |
|
184 | 178 |
|
185 | 179 | # -- Options for Texinfo output ------------------------------------------- |
|
188 | 182 | # (source start file, target name, title, author, |
189 | 183 | # dir menu entry, description, category) |
190 | 184 | texinfo_documents = [ |
191 | | - (master_doc, 'unasync', 'unasync Documentation', |
192 | | - author, 'unasync', 'The async transformation code.', |
193 | | - 'Miscellaneous'), |
| 185 | + ( |
| 186 | + master_doc, |
| 187 | + "unasync", |
| 188 | + "unasync Documentation", |
| 189 | + author, |
| 190 | + "unasync", |
| 191 | + "The async transformation code.", |
| 192 | + "Miscellaneous", |
| 193 | + ) |
194 | 194 | ] |
0 commit comments