|
1 | | -# -*- coding: utf-8 -*- |
2 | 1 | # |
3 | 2 | # rfc3986 documentation build configuration file, created by |
4 | 3 | # sphinx-quickstart on Tue Mar 14 07:06:46 2017. |
|
11 | 10 | # |
12 | 11 | # All configuration values have a default; values that are commented out |
13 | 12 | # serve to show the default. |
14 | | - |
15 | 13 | # If extensions (or modules to document with autodoc) are in another directory, |
16 | 14 | # add these directories to sys.path here. If the directory is relative to the |
17 | 15 | # documentation root, use os.path.abspath to make it absolute, like shown here. |
|
35 | 33 | # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom |
36 | 34 | # ones. |
37 | 35 | extensions = [ |
38 | | - 'sphinx.ext.autodoc', |
39 | | - 'sphinx.ext.doctest', |
40 | | - 'sphinx.ext.intersphinx', |
41 | | - 'sphinx.ext.coverage', |
42 | | - 'sphinx-prompt', |
| 36 | + "sphinx.ext.autodoc", |
| 37 | + "sphinx.ext.doctest", |
| 38 | + "sphinx.ext.intersphinx", |
| 39 | + "sphinx.ext.coverage", |
| 40 | + "sphinx-prompt", |
43 | 41 | ] |
44 | 42 |
|
45 | 43 | # Add any paths that contain templates here, relative to this directory. |
46 | | -templates_path = ['_templates'] |
| 44 | +templates_path = ["_templates"] |
47 | 45 |
|
48 | 46 | # The suffix(es) of source filenames. |
49 | 47 | # You can specify multiple suffix as a list of string: |
50 | 48 | # |
51 | 49 | # source_suffix = ['.rst', '.md'] |
52 | | -source_suffix = '.rst' |
| 50 | +source_suffix = ".rst" |
53 | 51 |
|
54 | 52 | # The master toctree document. |
55 | | -master_doc = 'index' |
| 53 | +master_doc = "index" |
56 | 54 |
|
57 | 55 | # General information about the project. |
58 | | -project = u'rfc3986' |
59 | | -copyright = u'2017, Ian Stapleton Cordasco' |
60 | | -author = u'Ian Stapleton Cordasco' |
| 56 | +project = "rfc3986" |
| 57 | +copyright = "2017, Ian Stapleton Cordasco" |
| 58 | +author = "Ian Stapleton Cordasco" |
61 | 59 |
|
62 | 60 | # The version info for the project you're documenting, acts as replacement for |
63 | 61 | # |version| and |release|, also used in various other places throughout the |
|
81 | 79 | exclude_patterns = [] |
82 | 80 |
|
83 | 81 | # The name of the Pygments (syntax highlighting) style to use. |
84 | | -pygments_style = 'sphinx' |
| 82 | +pygments_style = "sphinx" |
85 | 83 |
|
86 | 84 | # If true, `todo` and `todoList` produce output, else they produce nothing. |
87 | 85 | todo_include_todos = False |
|
92 | 90 | # The theme to use for HTML and HTML Help pages. See the documentation for |
93 | 91 | # a list of builtin themes. |
94 | 92 | # |
95 | | -html_theme = 'sphinx_rtd_theme' |
| 93 | +html_theme = "sphinx_rtd_theme" |
96 | 94 |
|
97 | 95 | # Theme options are theme-specific and customize the look and feel of a theme |
98 | 96 | # further. For a list of options available for each theme, see the |
|
103 | 101 | # Add any paths that contain custom static files (such as style sheets) here, |
104 | 102 | # relative to this directory. They are copied after the builtin static files, |
105 | 103 | # so a file named "default.css" will overwrite the builtin "default.css". |
106 | | -html_static_path = ['_static'] |
| 104 | +html_static_path = ["_static"] |
107 | 105 |
|
108 | 106 |
|
109 | 107 | # -- Options for HTMLHelp output ------------------------------------------ |
110 | 108 |
|
111 | 109 | # Output file base name for HTML help builder. |
112 | | -htmlhelp_basename = 'rfc3986doc' |
| 110 | +htmlhelp_basename = "rfc3986doc" |
113 | 111 |
|
114 | 112 |
|
115 | 113 | # -- Options for LaTeX output --------------------------------------------- |
|
118 | 116 | # The paper size ('letterpaper' or 'a4paper'). |
119 | 117 | # |
120 | 118 | # 'papersize': 'letterpaper', |
121 | | - |
122 | 119 | # The font size ('10pt', '11pt' or '12pt'). |
123 | 120 | # |
124 | 121 | # 'pointsize': '10pt', |
125 | | - |
126 | 122 | # Additional stuff for the LaTeX preamble. |
127 | 123 | # |
128 | 124 | # 'preamble': '', |
129 | | - |
130 | 125 | # Latex figure (float) alignment |
131 | 126 | # |
132 | 127 | # 'figure_align': 'htbp', |
|
136 | 131 | # (source start file, target name, title, |
137 | 132 | # author, documentclass [howto, manual, or own class]). |
138 | 133 | latex_documents = [ |
139 | | - (master_doc, 'rfc3986.tex', u'rfc3986 Documentation', |
140 | | - u'Ian Stapleton Cordasco', 'manual'), |
| 134 | + ( |
| 135 | + master_doc, |
| 136 | + "rfc3986.tex", |
| 137 | + "rfc3986 Documentation", |
| 138 | + "Ian Stapleton Cordasco", |
| 139 | + "manual", |
| 140 | + ), |
141 | 141 | ] |
142 | 142 |
|
143 | 143 |
|
144 | 144 | # -- Options for manual page output --------------------------------------- |
145 | 145 |
|
146 | 146 | # One entry per manual page. List of tuples |
147 | 147 | # (source start file, name, description, authors, manual section). |
148 | | -man_pages = [ |
149 | | - (master_doc, 'rfc3986', u'rfc3986 Documentation', |
150 | | - [author], 1) |
151 | | -] |
| 148 | +man_pages = [(master_doc, "rfc3986", "rfc3986 Documentation", [author], 1)] |
152 | 149 |
|
153 | 150 |
|
154 | 151 | # -- Options for Texinfo output ------------------------------------------- |
|
157 | 154 | # (source start file, target name, title, author, |
158 | 155 | # dir menu entry, description, category) |
159 | 156 | texinfo_documents = [ |
160 | | - (master_doc, 'rfc3986', u'rfc3986 Documentation', |
161 | | - author, 'rfc3986', 'One line description of project.', |
162 | | - 'Miscellaneous'), |
| 157 | + ( |
| 158 | + master_doc, |
| 159 | + "rfc3986", |
| 160 | + "rfc3986 Documentation", |
| 161 | + author, |
| 162 | + "rfc3986", |
| 163 | + "One line description of project.", |
| 164 | + "Miscellaneous", |
| 165 | + ), |
163 | 166 | ] |
164 | 167 |
|
165 | 168 |
|
166 | 169 | # Example configuration for intersphinx: refer to the Python standard library. |
167 | | -intersphinx_mapping = {'https://docs.python.org/': None} |
| 170 | +intersphinx_mapping = {"https://docs.python.org/": None} |
0 commit comments