|
10 | 10 | # add these directories to sys.path here. If the directory is relative to the |
11 | 11 | # documentation root, use os.path.abspath to make it absolute, like shown here. |
12 | 12 | # |
| 13 | +# import os |
| 14 | +# import sys |
| 15 | +# sys.path.insert(0, os.path.abspath('.')) |
| 16 | + |
| 17 | + |
| 18 | +# -- Project information ----------------------------------------------------- |
13 | 19 | import os |
14 | 20 | import sys |
15 | 21 |
|
|
18 | 24 | sys.path.append(os.path.abspath("extensions")) |
19 | 25 |
|
20 | 26 | on_rtd = os.environ.get("READTHEDOCS") == "True" |
21 | | - |
22 | | - |
23 | | -# -- Project information ----------------------------------------------------- |
24 | | - |
25 | 27 | project = "TwitchIO" |
26 | | -copyright = "2021, TwitchIO, PythonistaGuild" |
27 | | -author = "TwitchIO, PythonistaGuild" |
28 | | -version = "2.1" |
29 | | -release = "2.1.1" |
| 28 | +copyright = "2021, TwitchIO" |
| 29 | +author = "TwitchIO" |
| 30 | + |
| 31 | +# The full version, including alpha/beta/rc tags |
| 32 | +release = "2.1.3" |
30 | 33 |
|
31 | 34 |
|
32 | 35 | # -- General configuration --------------------------------------------------- |
|
42 | 45 | "attributetable", |
43 | 46 | ] |
44 | 47 |
|
| 48 | +# Add any paths that contain templates here, relative to this directory. |
| 49 | +templates_path = ["_templates"] |
| 50 | + |
| 51 | +# List of patterns, relative to source directory, that match files and |
| 52 | +# directories to ignore when looking for source files. |
| 53 | +# This pattern also affects html_static_path and html_extra_path. |
| 54 | +exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"] |
| 55 | + |
| 56 | + |
| 57 | +# -- Options for HTML output ------------------------------------------------- |
| 58 | + |
| 59 | +# The theme to use for HTML and HTML Help pages. See the documentation for |
| 60 | +# a list of builtin themes. |
| 61 | +# |
| 62 | +html_theme = "furo" |
| 63 | +# html_logo = "logo.png" |
| 64 | + |
| 65 | +html_theme_options = { |
| 66 | + "sidebar_hide_name": True, |
| 67 | + "light_logo": "logo_light.png", |
| 68 | + "dark_logo": "logo_dark.png", |
| 69 | +} |
| 70 | + |
| 71 | +# Add any paths that contain custom static files (such as style sheets) here, |
| 72 | +# relative to this directory. They are copied after the builtin static files, |
| 73 | +# so a file named "default.css" will overwrite the builtin "default.css". |
| 74 | +# These folders are copied to the documentation's HTML output |
| 75 | +html_static_path = ["_static"] |
| 76 | + |
| 77 | +# These paths are either relative to html_static_path |
| 78 | +# or fully qualified paths (eg. https://...) |
| 79 | +html_css_files = ["css/custom.css"] |
| 80 | + |
45 | 81 | if on_rtd: |
46 | 82 | extensions.append("sphinxcontrib.napoleon") |
47 | 83 | else: |
|
53 | 89 | napoleon_include_special_with_doc = False |
54 | 90 | autodoc_member_order = "groupwise" |
55 | 91 |
|
56 | | -# Add any paths that contain templates here, relative to this directory. |
57 | | -templates_path = ["_templates"] |
58 | | - |
59 | 92 | rst_prolog = """ |
60 | 93 | .. |coro| replace:: This function is a |corourl|_. |
61 | 94 | .. |maybecoro| replace:: This function *could be a* |corourl|_. |
62 | 95 | .. |corourl| replace:: *coroutine* |
63 | 96 | .. _corourl: https://docs.python.org/3/library/asyncio-task.html#coroutine |
| 97 | +.. |deco| replace:: This function is a **decorator**. |
64 | 98 | """ |
65 | 99 |
|
66 | 100 | # The suffix(es) of source filenames. |
|
71 | 105 |
|
72 | 106 | intersphinx_mapping = {"py": ("https://docs.python.org/3", None)} |
73 | 107 |
|
74 | | - |
75 | | -# List of patterns, relative to source directory, that match files and |
76 | | -# directories to ignore when looking for source files. |
77 | | -# This pattern also affects html_static_path and html_extra_path. |
78 | | -exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"] |
79 | | - |
80 | | - |
81 | | -# -- Options for HTML output ------------------------------------------------- |
82 | | - |
83 | | -# The theme to use for HTML and HTML Help pages. See the documentation for |
84 | | -# a list of builtin themes. |
85 | | -# |
86 | | -html_logo = "logo.png" |
87 | | -# Add any paths that contain custom static files (such as style sheets) here, |
88 | | -# relative to this directory. They are copied after the builtin static files, |
89 | | -# so a file named "default.css" will overwrite the builtin "default.css". |
90 | | -html_theme = "karma_sphinx_theme" |
91 | | -html_static_path = ["./_static"] |
92 | | -html_js_files = [] |
93 | | -html_css_files = ["css/custom.css"] |
94 | | -needs_sphinx = "3.4.3" |
95 | | - |
96 | | -# The master toctree document. |
97 | | -master_doc = "index" |
98 | | - |
99 | | -# The name of the Pygments (syntax highlighting) style to use. |
100 | | -pygments_style = "friendly" |
101 | | - |
102 | | -# If true, `_todo` and `todoList` produce output, else they produce nothing. |
103 | | -todo_include_todos = False |
104 | | - |
105 | | -# -- Options for HTML output ---------------------------------------------- |
106 | | - |
107 | | -# The theme to use for HTML and HTML Help pages. See the documentation for |
108 | | -# a list of builtin themes. |
109 | | -html_theme_options = {"navigation_depth": 4} |
110 | | - |
111 | | -# Theme options are theme-specific and customize the look and feel of a theme |
112 | | -# further. For a list of options available for each theme, see the |
113 | | -# documentation. |
114 | | -# |
115 | | -# html_theme_options = {} |
116 | | - |
117 | | -# Custom sidebar templates, must be a dictionary that maps document names |
118 | | -# to template names. |
119 | | -html_sidebars = { |
120 | | - "**": [ |
121 | | - "globaltoc.html", |
122 | | - "searchbox.html", |
123 | | - ] |
124 | | -} |
125 | | - |
126 | | - |
127 | | -# -- Options for HTMLHelp output ------------------------------------------ |
128 | | - |
129 | | -# Output file base name for HTML help builder. |
130 | | -htmlhelp_basename = "TwitchIOdoc" |
131 | | - |
132 | | -# -- Options for Texinfo output ------------------------------------------- |
133 | | - |
134 | | -# Grouping the document tree into Texinfo files. List of tuples |
135 | | -# (source start file, target name, title, author, |
136 | | -# dir menu entry, description, category) |
137 | | -texinfo_documents = [ |
138 | | - ( |
139 | | - master_doc, |
140 | | - "TwitchIO", |
141 | | - "TwitchIO Documentation", |
142 | | - author, |
143 | | - "TwitchIO", |
144 | | - "A Python IRC and API wrapper for Twitch.", |
145 | | - "Miscellaneous", |
146 | | - ), |
147 | | -] |
148 | | - |
149 | | - |
150 | | -def setup(app): |
151 | | - app.add_css_file("/style.css") |
| 108 | +pygments_style = "sphinx" |
| 109 | +pygments_dark_style = "monokai" |
0 commit comments