|
18 | 18 | #
|
19 | 19 | import os
|
20 | 20 | import sys
|
21 |
| -sys.path.insert(0, os.path.abspath('..')) |
| 21 | + |
| 22 | +sys.path.insert(0, os.path.abspath("..")) |
22 | 23 |
|
23 | 24 | from semver import __version__ # noqa: E402
|
24 | 25 |
|
|
32 | 33 | # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
|
33 | 34 | # ones.
|
34 | 35 | extensions = [
|
35 |
| - 'sphinx.ext.autodoc', |
36 |
| - 'sphinx.ext.intersphinx', |
37 |
| - 'sphinx.ext.napoleon', |
38 |
| - 'sphinx.ext.extlinks', |
| 36 | + "sphinx.ext.autodoc", |
| 37 | + "sphinx.ext.intersphinx", |
| 38 | + "sphinx.ext.napoleon", |
| 39 | + "sphinx.ext.extlinks", |
39 | 40 | ]
|
40 | 41 |
|
41 | 42 | # Add any paths that contain templates here, relative to this directory.
|
42 |
| -templates_path = ['_templates'] |
| 43 | +templates_path = ["_templates"] |
43 | 44 |
|
44 | 45 | # The suffix(es) of source filenames.
|
45 | 46 | # You can specify multiple suffix as a list of string:
|
46 | 47 | #
|
47 |
| -source_suffix = '.rst' |
| 48 | +source_suffix = ".rst" |
48 | 49 |
|
49 | 50 | # The master toctree document.
|
50 |
| -master_doc = 'index' |
| 51 | +master_doc = "index" |
51 | 52 |
|
52 | 53 | # General information about the project.
|
53 |
| -project = 'python-semver' |
54 |
| -copyright = '2018, Kostiantyn Rybnikov and all' |
55 |
| -author = 'Kostiantyn Rybnikov and all' |
| 54 | +project = "python-semver" |
| 55 | +copyright = "2018, Kostiantyn Rybnikov and all" |
| 56 | +author = "Kostiantyn Rybnikov and all" |
56 | 57 |
|
57 | 58 | # The version info for the project you're documenting, acts as replacement for
|
58 | 59 | # |version| and |release|, also used in various other places throughout the
|
|
73 | 74 | # List of patterns, relative to source directory, that match files and
|
74 | 75 | # directories to ignore when looking for source files.
|
75 | 76 | # This patterns also effect to html_static_path and html_extra_path
|
76 |
| -exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store'] |
| 77 | +exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"] |
77 | 78 |
|
78 | 79 | # The name of the Pygments (syntax highlighting) style to use.
|
79 |
| -pygments_style = 'sphinx' |
| 80 | +pygments_style = "sphinx" |
80 | 81 |
|
81 | 82 | # If true, `todo` and `todoList` produce output, else they produce nothing.
|
82 | 83 | todo_include_todos = False
|
83 | 84 |
|
84 | 85 | # Markup to shorten external links
|
85 | 86 | # See https://www.sphinx-doc.org/en/master/usage/extensions/extlinks.html
|
86 |
| -extlinks = {'gh': ('https://github.com/python-semver/python-semver/issues/%s', |
87 |
| - '#'), |
88 |
| - 'pr': ('https://github.com/python-semver/python-semver/pull/%s', |
89 |
| - 'PR #'), |
90 |
| - } |
| 87 | +extlinks = { |
| 88 | + "gh": ("https://github.com/python-semver/python-semver/issues/%s", "#"), |
| 89 | + "pr": ("https://github.com/python-semver/python-semver/pull/%s", "PR #"), |
| 90 | +} |
91 | 91 |
|
92 | 92 | # -- Options for HTML output ----------------------------------------------
|
93 | 93 |
|
94 | 94 | # The theme to use for HTML and HTML Help pages. See the documentation for
|
95 | 95 | # a list of builtin themes.
|
96 | 96 | #
|
97 | 97 | # html_theme = 'alabaster'
|
98 |
| -html_theme = 'sphinx_rtd_theme' |
| 98 | +html_theme = "sphinx_rtd_theme" |
99 | 99 |
|
100 | 100 | # Theme options are theme-specific and customize the look and feel of a theme
|
101 | 101 | # further. For a list of options available for each theme, see the
|
|
106 | 106 | # Add any paths that contain custom static files (such as style sheets) here,
|
107 | 107 | # relative to this directory. They are copied after the builtin static files,
|
108 | 108 | # so a file named "default.css" will overwrite the builtin "default.css".
|
109 |
| -html_static_path = ['_static'] |
| 109 | +html_static_path = ["_static"] |
110 | 110 |
|
111 |
| -html_css_files = ['css/default.css'] |
| 111 | +html_css_files = ["css/default.css"] |
112 | 112 |
|
113 | 113 | # Custom sidebar templates, must be a dictionary that maps document names
|
114 | 114 | # to template names.
|
115 | 115 | #
|
116 | 116 | # This is required for the alabaster theme
|
117 | 117 | # refs: http://alabaster.readthedocs.io/en/latest/installation.html#sidebars
|
118 | 118 | html_sidebars = {
|
119 |
| - '**': [ |
120 |
| - 'about.html', |
121 |
| - 'navigation.html', |
122 |
| - 'relations.html', # needs 'show_related': True theme option to display |
123 |
| - 'searchbox.html', |
124 |
| - 'donate.html', |
| 119 | + "**": [ |
| 120 | + "about.html", |
| 121 | + "navigation.html", |
| 122 | + "relations.html", # needs 'show_related': True theme option to display |
| 123 | + "searchbox.html", |
| 124 | + "donate.html", |
125 | 125 | ]
|
126 | 126 | }
|
127 | 127 |
|
|
130 | 130 | # -- Options for HTMLHelp output ------------------------------------------
|
131 | 131 |
|
132 | 132 | # Output file base name for HTML help builder.
|
133 |
| -htmlhelp_basename = 'semverdoc' |
| 133 | +htmlhelp_basename = "semverdoc" |
134 | 134 |
|
135 | 135 |
|
136 | 136 | # -- Options for LaTeX output ---------------------------------------------
|
|
139 | 139 | # The paper size ('letterpaper' or 'a4paper').
|
140 | 140 | #
|
141 | 141 | # 'papersize': 'letterpaper',
|
142 |
| - |
143 | 142 | # The font size ('10pt', '11pt' or '12pt').
|
144 | 143 | #
|
145 | 144 | # 'pointsize': '10pt',
|
146 |
| - |
147 | 145 | # Additional stuff for the LaTeX preamble.
|
148 | 146 | #
|
149 | 147 | # 'preamble': '',
|
150 |
| - |
151 | 148 | # Latex figure (float) alignment
|
152 | 149 | #
|
153 | 150 | # 'figure_align': 'htbp',
|
|
157 | 154 | # (source start file, target name, title,
|
158 | 155 | # author, documentclass [howto, manual, or own class]).
|
159 | 156 | latex_documents = [
|
160 |
| - (master_doc, 'semver.tex', 'python-semver Documentation', |
161 |
| - 'Kostiantyn Rybnikov and all', 'manual'), |
| 157 | + ( |
| 158 | + master_doc, |
| 159 | + "semver.tex", |
| 160 | + "python-semver Documentation", |
| 161 | + "Kostiantyn Rybnikov and all", |
| 162 | + "manual", |
| 163 | + ) |
162 | 164 | ]
|
163 | 165 |
|
164 | 166 |
|
|
169 | 171 | manpage_doc = "pysemver"
|
170 | 172 |
|
171 | 173 | man_pages = [
|
172 |
| - (manpage_doc, |
173 |
| - 'pysemver', |
174 |
| - 'Helper script for Semantic Versioning', |
175 |
| - ["Thomas Schraitle"], |
176 |
| - 1) |
| 174 | + ( |
| 175 | + manpage_doc, |
| 176 | + "pysemver", |
| 177 | + "Helper script for Semantic Versioning", |
| 178 | + ["Thomas Schraitle"], |
| 179 | + 1, |
| 180 | + ) |
177 | 181 | ]
|
178 | 182 |
|
179 | 183 |
|
|
183 | 187 | # (source start file, target name, title, author,
|
184 | 188 | # dir menu entry, description, category)
|
185 | 189 | texinfo_documents = [
|
186 |
| - (master_doc, 'semver', 'python-semver Documentation', |
187 |
| - author, 'semver', 'One line description of project.', |
188 |
| - 'Miscellaneous'), |
| 190 | + ( |
| 191 | + master_doc, |
| 192 | + "semver", |
| 193 | + "python-semver Documentation", |
| 194 | + author, |
| 195 | + "semver", |
| 196 | + "One line description of project.", |
| 197 | + "Miscellaneous", |
| 198 | + ) |
189 | 199 | ]
|
0 commit comments