|
11 | 11 | import os |
12 | 12 | import sys |
13 | 13 |
|
14 | | -sys.path.append(os.path.abspath('..')) |
| 14 | +sys.path.append(os.path.abspath("..")) |
15 | 15 | sys.path.append(os.path.abspath("../..")) |
16 | | -sys.path.append(os.path.abspath('extensions')) |
| 16 | +sys.path.append(os.path.abspath("extensions")) |
17 | 17 |
|
18 | 18 | from pincer import __version__ |
19 | 19 |
|
20 | 20 | # -- Project information ----------------------------------------------------- |
21 | 21 |
|
22 | 22 |
|
23 | 23 | project = "Pincer Library" |
24 | | -copyright = '2021, Pincer' |
| 24 | +copyright = "2021, Pincer" |
25 | 25 | author = "Sigmanificient, Arthurdw" |
26 | 26 |
|
27 | 27 |
|
28 | 28 | # The full version, including alpha/beta/rc tags. |
29 | 29 | release = __version__ |
30 | 30 |
|
31 | | -branch = 'main' if __version__.endswith('a') else 'v' + __version__ |
| 31 | +branch = "main" if __version__.endswith("a") else "v" + __version__ |
32 | 32 |
|
33 | 33 | # -- General configuration --------------------------------------------------- |
34 | 34 |
|
|
37 | 37 | # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom |
38 | 38 | # ones. |
39 | 39 | extensions = [ |
40 | | - 'sphinx_design', |
41 | | - 'sphinx.ext.napoleon', |
42 | | - 'sphinx.ext.autodoc', |
43 | | - 'sphinx.ext.intersphinx', |
44 | | - 'exception_hierarchy', |
45 | | - 'attributetable', |
46 | | - 'silence', |
47 | | - 'sphinxcontrib_trio', |
48 | | - 'sphinxcontrib.mermaid', |
| 40 | + "sphinx_design", |
| 41 | + "sphinx.ext.napoleon", |
| 42 | + "sphinx.ext.autodoc", |
| 43 | + "sphinx.ext.intersphinx", |
| 44 | + "exception_hierarchy", |
| 45 | + "attributetable", |
| 46 | + "silence", |
| 47 | + "sphinxcontrib_trio", |
| 48 | + "sphinxcontrib.mermaid", |
49 | 49 | ] |
50 | 50 |
|
51 | 51 | add_module_names = False |
52 | 52 |
|
53 | | -autodoc_typehints = 'none' |
| 53 | +autodoc_typehints = "none" |
54 | 54 |
|
55 | | -autodoc_member_order = 'alphabetical' |
| 55 | +autodoc_member_order = "alphabetical" |
56 | 56 |
|
57 | 57 | set_type_checking_flag = True |
58 | 58 |
|
59 | | -mermaid_output_format = 'raw' |
| 59 | +mermaid_output_format = "raw" |
60 | 60 |
|
61 | 61 | resource_links = { |
62 | | - 'discord': 'https://discord.gg/et54DgVjMX', |
63 | | - 'issues': 'https://github.com/Pincer-org/Pincer/issues', |
64 | | - 'discussions': 'https://github.com/Pincer-org/Pincer/discussions', |
65 | | - 'examples': f'https://github.com/Pincer-org/Pincer/tree/{branch}/examples', |
| 62 | + "discord": "https://discord.gg/et54DgVjMX", |
| 63 | + "issues": "https://github.com/Pincer-org/Pincer/issues", |
| 64 | + "discussions": "https://github.com/Pincer-org/Pincer/discussions", |
| 65 | + "examples": f"https://github.com/Pincer-org/Pincer/tree/{branch}/examples", |
66 | 66 | } |
67 | 67 |
|
68 | 68 | intersphinx_mapping = { |
69 | | - 'py': ('https://docs.python.org/3', None), |
70 | | - 'ws': ('https://websockets.readthedocs.io/en/stable', None), |
71 | | - 'pil': ('https://pillow.readthedocs.io/en/stable', None) |
| 69 | + "py": ("https://docs.python.org/3", None), |
| 70 | + "ws": ("https://websockets.readthedocs.io/en/stable", None), |
| 71 | + "pil": ("https://pillow.readthedocs.io/en/stable", None), |
72 | 72 | } |
73 | 73 |
|
74 | 74 | # Add any paths that contain templates here, relative to this directory. |
|
77 | 77 | # List of patterns, relative to source directory, that match files and |
78 | 78 | # directories to ignore when looking for source files. |
79 | 79 | # This pattern also affects html_static_path and html_extra_path. |
80 | | -exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store'] |
| 80 | +exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"] |
81 | 81 |
|
82 | | -autodoc_default_options = { |
83 | | - 'members': True, |
84 | | - 'show-inheritance': True |
85 | | -} |
| 82 | +autodoc_default_options = {"members": True, "show-inheritance": True} |
86 | 83 |
|
87 | 84 | # -- Options for HTML output ------------------------------------------------- |
88 | 85 |
|
89 | 86 | # The theme to use for HTML and HTML Help pages. See the documentation for |
90 | 87 | # a list of builtin themes. |
91 | 88 | # |
92 | | -html_logo = '../assets/img/icon_small.png' |
93 | | -html_favicon = '../assets/img/icon.ico' |
94 | | -html_theme = 'furo' |
| 89 | +html_logo = "../assets/img/icon_small.png" |
| 90 | +html_favicon = "../assets/img/icon.ico" |
| 91 | +html_theme = "furo" |
95 | 92 | # Material theme options (see theme.conf for more information) |
96 | 93 | html_theme_options = { |
97 | | - 'light_css_variables': { |
98 | | - 'color-brand-primary': '#4C8CBF', |
99 | | - 'color-brand-content': '#306998', |
100 | | - 'color-admonition-background': 'blue', |
| 94 | + "light_css_variables": { |
| 95 | + "color-brand-primary": "#4C8CBF", |
| 96 | + "color-brand-content": "#306998", |
| 97 | + "color-admonition-background": "blue", |
101 | 98 | }, |
102 | | - 'dark_css_variables': { |
103 | | - 'color-brand-primary': '#306998', |
104 | | - 'color-brand-content': '#FFE871', |
105 | | - 'color-admonition-background': 'yellow', |
| 99 | + "dark_css_variables": { |
| 100 | + "color-brand-primary": "#306998", |
| 101 | + "color-brand-content": "#FFE871", |
| 102 | + "color-admonition-background": "yellow", |
106 | 103 | }, |
107 | 104 | "sidebar_hide_name": True, |
108 | 105 | } |
109 | | -pygments_style = 'monokai' |
| 106 | +pygments_style = "monokai" |
110 | 107 | default_dark_mode = True |
111 | 108 | # Add any paths that contain custom static files (such as style sheets) here, |
112 | 109 | # relative to this directory. They are copied after the builtin static files, |
113 | 110 | # so a file named 'default.css' will overwrite the builtin 'default.css'. |
114 | | -html_static_path = ['_static'] |
| 111 | +html_static_path = ["_static"] |
115 | 112 | html_css_files = ["custom.css"] |
116 | 113 |
|
117 | | -rst_prolog = ''' |
| 114 | +rst_prolog = """ |
118 | 115 | .. |coro| replace:: This function is a |coroutine_link|_.\n\n |
119 | 116 | .. |maybecoro| replace:: This function *could be a* |coroutine_link|_. |
120 | 117 | .. |coroutine_link| replace:: *coroutine* |
121 | 118 | .. _coroutine_link: https://docs.python.org/3/library/asyncio-task.html#coroutine |
122 | 119 | .. |default| raw:: html |
123 | 120 |
|
124 | 121 | <div class="default-value-section"> <span class="default-value-label">Default:</span> |
125 | | -''' |
| 122 | +""" |
126 | 123 |
|
127 | 124 | # The suffix of source filenames. |
128 | | -source_suffix = '.rst' |
| 125 | +source_suffix = ".rst" |
0 commit comments