|
12 | 12 | # add these directories to sys.path here. If the directory is relative to the |
13 | 13 | # documentation root, use os.path.abspath to make it absolute, like shown here. |
14 | 14 | # |
15 | | -import os |
16 | | -import sys |
17 | 15 | from pathlib import Path |
18 | 16 |
|
19 | 17 | import toml |
20 | 18 |
|
21 | 19 | # -- Project information ----------------------------------------------------- |
22 | 20 |
|
23 | | -project = 'rpc-project' |
24 | | -copyright = '2023, doronz88' |
25 | | -author = 'doronz88' |
| 21 | +project = "rpc-project" |
| 22 | +copyright = "2023, doronz88" |
| 23 | +author = "doronz88" |
26 | 24 |
|
27 | 25 | # The short X.Y version |
28 | 26 | # The full version, including alpha/beta/rc tags |
29 | 27 |
|
30 | | -release = version = toml.loads(Path('../src/rpcclient/pyproject.toml').read_text())['project']['version'] |
| 28 | +release = version = toml.loads( |
| 29 | + Path("../src/rpcclient/pyproject.toml").read_text(), |
| 30 | +)["project"]["version"] |
31 | 31 |
|
32 | 32 |
|
33 | 33 | # -- General configuration --------------------------------------------------- |
|
39 | 39 | # Add any Sphinx extension module names here, as strings. They can be |
40 | 40 | # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom |
41 | 41 | # ones. |
42 | | -extensions = [ |
43 | | - 'sphinx.ext.autodoc', |
44 | | - 'sphinx.ext.viewcode', |
45 | | - 'sphinx.ext.napoleon' |
46 | | -] |
| 42 | +extensions = ["sphinx.ext.autodoc", "sphinx.ext.viewcode", "sphinx.ext.napoleon"] |
47 | 43 | # Add any paths that contain templates here, relative to this directory. |
48 | | -templates_path = ['_templates'] |
| 44 | +templates_path = ["_templates"] |
49 | 45 |
|
50 | 46 | # The suffix(es) of source filenames. |
51 | 47 | # You can specify multiple suffix as a list of string: |
52 | 48 | # |
53 | 49 | # source_suffix = ['.rst', '.md'] |
54 | | -source_suffix = '.rst' |
| 50 | +source_suffix = ".rst" |
55 | 51 |
|
56 | 52 | # The master toctree document. |
57 | | -master_doc = 'index' |
| 53 | +master_doc = "index" |
58 | 54 |
|
59 | 55 | # The language for content autogenerated by Sphinx. Refer to documentation |
60 | 56 | # for a list of supported languages. |
61 | 57 | # |
62 | 58 | # This is also used if you do content translation via gettext catalogs. |
63 | 59 | # Usually you set "language" from the command line for these cases. |
64 | | -language = 'en' |
| 60 | +language = "en" |
65 | 61 |
|
66 | 62 | # List of patterns, relative to source directory, that match files and |
67 | 63 | # directories to ignore when looking for source files. |
68 | 64 | # This pattern also affects html_static_path and html_extra_path. |
69 | | -exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store'] |
| 65 | +exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"] |
70 | 66 |
|
71 | 67 | # The name of the Pygments (syntax highlighting) style to use. |
72 | | -pygments_style = 'stata-dark' |
| 68 | +pygments_style = "stata-dark" |
73 | 69 |
|
74 | 70 |
|
75 | 71 | # -- Options for HTML output ------------------------------------------------- |
76 | 72 |
|
77 | 73 | # The theme to use for HTML and HTML Help pages. See the documentation for |
78 | 74 | # a list of builtin themes. |
79 | 75 | # |
80 | | -html_theme = 'sphinx_rtd_theme' |
| 76 | +html_theme = "sphinx_rtd_theme" |
81 | 77 |
|
82 | 78 | # Theme options are theme-specific and customize the look and feel of a theme |
83 | 79 | # further. For a list of options available for each theme, see the |
84 | 80 | # documentation. |
85 | 81 | # |
86 | 82 | html_theme_options = { |
87 | | - 'collapse_navigation': True, |
88 | | - 'sticky_navigation': True, |
89 | | - 'navigation_depth': 2, |
90 | | - 'includehidden': True, |
91 | | - 'titles_only': False |
| 83 | + "collapse_navigation": True, |
| 84 | + "sticky_navigation": True, |
| 85 | + "navigation_depth": 2, |
| 86 | + "includehidden": True, |
| 87 | + "titles_only": False, |
92 | 88 | } |
93 | 89 |
|
94 | 90 | # Add any paths that contain custom static files (such as style sheets) here, |
95 | 91 | # relative to this directory. They are copied after the builtin static files, |
96 | 92 | # so a file named "default.css" will overwrite the builtin "default.css". |
97 | | -html_static_path = ['_static'] |
| 93 | +html_static_path = ["_static"] |
98 | 94 |
|
99 | 95 | # Custom sidebar templates, must be a dictionary that maps document names |
100 | 96 | # to template names. |
|
110 | 106 | # -- Options for HTMLHelp output --------------------------------------------- |
111 | 107 |
|
112 | 108 | # Output file base name for HTML help builder. |
113 | | -htmlhelp_basename = 'rpc-projectdoc' |
| 109 | +htmlhelp_basename = "rpc-projectdoc" |
114 | 110 |
|
115 | 111 |
|
116 | 112 | # -- Options for LaTeX output ------------------------------------------------ |
|
119 | 115 | # The paper size ('letterpaper' or 'a4paper'). |
120 | 116 | # |
121 | 117 | # 'papersize': 'letterpaper', |
122 | | - |
123 | 118 | # The font size ('10pt', '11pt' or '12pt'). |
124 | 119 | # |
125 | 120 | # 'pointsize': '10pt', |
126 | | - |
127 | 121 | # Additional stuff for the LaTeX preamble. |
128 | 122 | # |
129 | 123 | # 'preamble': '', |
130 | | - |
131 | 124 | # Latex figure (float) alignment |
132 | 125 | # |
133 | 126 | # 'figure_align': 'htbp', |
|
137 | 130 | # (source start file, target name, title, |
138 | 131 | # author, documentclass [howto, manual, or own class]). |
139 | 132 | latex_documents = [ |
140 | | - (master_doc, 'rpc-project.tex', 'rpc-project Documentation', |
141 | | - 'doronz88', 'manual'), |
| 133 | + (master_doc, "rpc-project.tex", "rpc-project Documentation", "doronz88", "manual"), |
142 | 134 | ] |
143 | 135 |
|
144 | 136 |
|
145 | 137 | # -- Options for manual page output ------------------------------------------ |
146 | 138 |
|
147 | 139 | # One entry per manual page. List of tuples |
148 | 140 | # (source start file, name, description, authors, manual section). |
149 | | -man_pages = [ |
150 | | - (master_doc, 'rpc-project', 'rpc-project Documentation', |
151 | | - [author], 1) |
152 | | -] |
| 141 | +man_pages = [(master_doc, "rpc-project", "rpc-project Documentation", [author], 1)] |
153 | 142 |
|
154 | 143 |
|
155 | 144 | # -- Options for Texinfo output ---------------------------------------------- |
|
158 | 147 | # (source start file, target name, title, author, |
159 | 148 | # dir menu entry, description, category) |
160 | 149 | texinfo_documents = [ |
161 | | - (master_doc, 'rpc-project', 'rpc-project Documentation', |
162 | | - author, 'rpc-project', 'One line description of project.', |
163 | | - 'Miscellaneous'), |
| 150 | + ( |
| 151 | + master_doc, |
| 152 | + "rpc-project", |
| 153 | + "rpc-project Documentation", |
| 154 | + author, |
| 155 | + "rpc-project", |
| 156 | + "One line description of project.", |
| 157 | + "Miscellaneous", |
| 158 | + ), |
164 | 159 | ] |
165 | 160 |
|
166 | 161 |
|
|
179 | 174 | # epub_uid = '' |
180 | 175 |
|
181 | 176 | # A list of files that should not be packed into the epub file. |
182 | | -epub_exclude_files = ['search.html'] |
| 177 | +epub_exclude_files = ["search.html"] |
183 | 178 |
|
184 | 179 |
|
185 | 180 | # -- Extension configuration ------------------------------------------------- |
0 commit comments