|
37 | 37 | extensions = []
|
38 | 38 |
|
39 | 39 | # Add any paths that contain templates here, relative to this directory.
|
40 |
| -templates_path = ['_templates'] |
| 40 | +templates_path = ["_templates"] |
41 | 41 |
|
42 | 42 | # The suffix(es) of source filenames.
|
43 | 43 | # You can specify multiple suffix as a list of string:
|
44 | 44 | #
|
45 | 45 | # source_suffix = ['.rst', '.md']
|
46 |
| -source_suffix = '.rst' |
| 46 | +source_suffix = ".rst" |
47 | 47 |
|
48 | 48 | # The master toctree document.
|
49 |
| -master_doc = 'index' |
| 49 | +master_doc = "index" |
50 | 50 |
|
51 | 51 | # General information about the project.
|
52 |
| -project = 'python-twitch-client' |
53 |
| -copyright = '2018, Tomaz Sifrer' |
54 |
| -author = 'Tomaz Sifrer' |
| 52 | +project = "python-twitch-client" |
| 53 | +copyright = "2018-2020, Tomaz Sifrer" |
| 54 | +author = "Tomaz Sifrer" |
55 | 55 |
|
56 | 56 | # The version info for the project you're documenting, acts as replacement for
|
57 | 57 | # |version| and |release|, also used in various other places throughout the
|
58 | 58 | # built documents.
|
59 | 59 | #
|
60 | 60 | # The short X.Y version.
|
61 |
| -version = '0.1' |
| 61 | +version = "0.1" |
62 | 62 | # The full version, including alpha/beta/rc tags.
|
63 |
| -release = '0.1' |
| 63 | +release = "0.1" |
64 | 64 |
|
65 | 65 | # The language for content autogenerated by Sphinx. Refer to documentation
|
66 | 66 | # for a list of supported languages.
|
|
72 | 72 | # List of patterns, relative to source directory, that match files and
|
73 | 73 | # directories to ignore when looking for source files.
|
74 | 74 | # This patterns also effect to html_static_path and html_extra_path
|
75 |
| -exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store'] |
| 75 | +exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"] |
76 | 76 |
|
77 | 77 | # The name of the Pygments (syntax highlighting) style to use.
|
78 |
| -pygments_style = 'sphinx' |
| 78 | +pygments_style = "sphinx" |
79 | 79 |
|
80 | 80 | # If true, `todo` and `todoList` produce output, else they produce nothing.
|
81 | 81 | todo_include_todos = False
|
|
86 | 86 | # The theme to use for HTML and HTML Help pages. See the documentation for
|
87 | 87 | # a list of builtin themes.
|
88 | 88 |
|
89 |
| -html_theme = 'default' |
| 89 | +html_theme = "default" |
90 | 90 |
|
91 | 91 | # on_rtd is whether we are on readthedocs.org, this line of code grabbed from docs.readthedocs.org
|
92 |
| -on_rtd = os.environ.get('READTHEDOCS', None) == 'True' |
| 92 | +on_rtd = os.environ.get("READTHEDOCS", None) == "True" |
93 | 93 |
|
94 | 94 | if not on_rtd: # only import and set the theme if we're building docs locally
|
95 | 95 | import sphinx_rtd_theme
|
96 |
| - html_theme = 'sphinx_rtd_theme' |
| 96 | + |
| 97 | + html_theme = "sphinx_rtd_theme" |
97 | 98 | html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
|
98 | 99 |
|
99 | 100 | # Theme options are theme-specific and customize the look and feel of a theme
|
|
105 | 106 | # Add any paths that contain custom static files (such as style sheets) here,
|
106 | 107 | # relative to this directory. They are copied after the builtin static files,
|
107 | 108 | # so a file named "default.css" will overwrite the builtin "default.css".
|
108 |
| -html_static_path = ['_static'] |
| 109 | +html_static_path = ["_static"] |
109 | 110 |
|
110 | 111 |
|
111 | 112 | # -- Options for HTMLHelp output ------------------------------------------
|
112 | 113 |
|
113 | 114 | # Output file base name for HTML help builder.
|
114 |
| -htmlhelp_basename = 'python-twitch-clientdoc' |
| 115 | +htmlhelp_basename = "python-twitch-clientdoc" |
115 | 116 |
|
116 | 117 |
|
117 | 118 | # -- Options for LaTeX output ---------------------------------------------
|
|
120 | 121 | # The paper size ('letterpaper' or 'a4paper').
|
121 | 122 | #
|
122 | 123 | # 'papersize': 'letterpaper',
|
123 |
| - |
124 | 124 | # The font size ('10pt', '11pt' or '12pt').
|
125 | 125 | #
|
126 | 126 | # 'pointsize': '10pt',
|
127 |
| - |
128 | 127 | # Additional stuff for the LaTeX preamble.
|
129 | 128 | #
|
130 | 129 | # 'preamble': '',
|
131 |
| - |
132 | 130 | # Latex figure (float) alignment
|
133 | 131 | #
|
134 | 132 | # 'figure_align': 'htbp',
|
|
138 | 136 | # (source start file, target name, title,
|
139 | 137 | # author, documentclass [howto, manual, or own class]).
|
140 | 138 | latex_documents = [
|
141 |
| - (master_doc, 'python-twitch-client.tex', 'python-twitch-client Documentation', |
142 |
| - 'Tomaz Sifrer', 'manual'), |
| 139 | + ( |
| 140 | + master_doc, |
| 141 | + "python-twitch-client.tex", |
| 142 | + "python-twitch-client Documentation", |
| 143 | + "Tomaz Sifrer", |
| 144 | + "manual", |
| 145 | + ), |
143 | 146 | ]
|
144 | 147 |
|
145 | 148 |
|
|
148 | 151 | # One entry per manual page. List of tuples
|
149 | 152 | # (source start file, name, description, authors, manual section).
|
150 | 153 | man_pages = [
|
151 |
| - (master_doc, 'python-twitch-client', 'python-twitch-client Documentation', |
152 |
| - [author], 1) |
| 154 | + ( |
| 155 | + master_doc, |
| 156 | + "python-twitch-client", |
| 157 | + "python-twitch-client Documentation", |
| 158 | + [author], |
| 159 | + 1, |
| 160 | + ) |
153 | 161 | ]
|
154 | 162 |
|
155 | 163 |
|
|
159 | 167 | # (source start file, target name, title, author,
|
160 | 168 | # dir menu entry, description, category)
|
161 | 169 | texinfo_documents = [
|
162 |
| - (master_doc, 'python-twitch-client', 'python-twitch-client Documentation', |
163 |
| - author, 'python-twitch-client', 'An easy to use Python library for accessing the Twitch API.', |
164 |
| - 'Miscellaneous'), |
| 170 | + ( |
| 171 | + master_doc, |
| 172 | + "python-twitch-client", |
| 173 | + "python-twitch-client Documentation", |
| 174 | + author, |
| 175 | + "python-twitch-client", |
| 176 | + "An easy to use Python library for accessing the Twitch API.", |
| 177 | + "Miscellaneous", |
| 178 | + ), |
165 | 179 | ]
|
0 commit comments