|
| 1 | +from __future__ import annotations |
| 2 | + |
1 | 3 | # |
2 | 4 | # Progress Bar documentation build configuration file, created by |
3 | 5 | # sphinx-quickstart on Tue Aug 20 11:47:33 2013. |
|
9 | 11 | # |
10 | 12 | # All configuration values have a default; values that are commented out |
11 | 13 | # serve to show the default. |
12 | | - |
13 | 14 | import datetime |
14 | 15 | import os |
15 | 16 | import sys |
|
59 | 60 |
|
60 | 61 | # General information about the project. |
61 | 62 | project = 'Progress Bar' |
62 | | -project_slug = ''.join(project.capitalize().split()) |
| 63 | +project_slug: str = ''.join(project.capitalize().split()) |
63 | 64 | copyright = f'{datetime.date.today().year}, <a href="http://wol.ph/">{metadata.__author__}</a>' |
64 | 65 |
|
65 | 66 | # The version info for the project you're documenting, acts as replacement for |
66 | 67 | # |version| and |release|, also used in various other places throughout the |
67 | 68 | # built documents. |
68 | 69 | # |
69 | 70 | # The short X.Y version. |
70 | | -version = metadata.__version__ |
| 71 | +version: str = metadata.__version__ |
71 | 72 | # The full version, including alpha/beta/rc tags. |
72 | | -release = metadata.__version__ |
| 73 | +release: str = metadata.__version__ |
73 | 74 |
|
74 | 75 | # The language for content autogenerated by Sphinx. Refer to documentation |
75 | 76 | # for a list of supported languages. |
|
202 | 203 |
|
203 | 204 | # Grouping the document tree into LaTeX files. List of tuples |
204 | 205 | # (source start file, target name, title, author, documentclass [howto/manual]). |
205 | | -latex_documents = [ |
| 206 | +latex_documents: list[tuple[str, ...]] = [ |
206 | 207 | ( |
207 | 208 | 'index', |
208 | 209 | f'{project_slug}.tex', |
|
237 | 238 |
|
238 | 239 | # One entry per manual page. List of tuples |
239 | 240 | # (source start file, name, description, authors, manual section). |
240 | | -man_pages = [ |
| 241 | +man_pages: list[tuple[str, str, str, list[str], int]] = [ |
241 | 242 | ( |
242 | 243 | 'index', |
243 | 244 | project_slug.lower(), |
|
256 | 257 | # Grouping the document tree into Texinfo files. List of tuples |
257 | 258 | # (source start file, target name, title, author, |
258 | 259 | # dir menu entry, description, category) |
259 | | -texinfo_documents = [ |
| 260 | +texinfo_documents: list[tuple[str, ...]] = [ |
260 | 261 | ( |
261 | 262 | 'index', |
262 | 263 | project_slug, |
|
284 | 285 | # -- Options for Epub output --------------------------------------------- |
285 | 286 |
|
286 | 287 | # Bibliographic Dublin Core info. |
287 | | -epub_title = project |
288 | | -epub_author = metadata.__author__ |
289 | | -epub_publisher = metadata.__author__ |
290 | | -epub_copyright = copyright |
| 288 | +epub_title: str = project |
| 289 | +epub_author: str = metadata.__author__ |
| 290 | +epub_publisher: str = metadata.__author__ |
| 291 | +epub_copyright: str = copyright |
291 | 292 |
|
292 | 293 | # The language of the text. It defaults to the language option |
293 | 294 | # or en if the language is not set. |
|
340 | 341 |
|
341 | 342 |
|
342 | 343 | # Example configuration for intersphinx: refer to the Python standard library. |
343 | | -intersphinx_mapping = {'python': ('https://docs.python.org/3', None)} |
| 344 | +intersphinx_mapping: dict[str, tuple[str, None]] = { |
| 345 | + 'python': ('https://docs.python.org/3', None) |
| 346 | +} |
0 commit comments