|
20 | 20 | import os |
21 | 21 | import sys |
22 | 22 |
|
23 | | -on_rtd = os.environ.get('READTHEDOCS') == 'True' |
24 | | -sys.path.insert(0, os.path.abspath('..')) |
| 23 | +on_rtd = os.environ.get("READTHEDOCS") == "True" |
| 24 | +sys.path.insert(0, os.path.abspath("..")) |
25 | 25 |
|
26 | 26 | if on_rtd: |
27 | | - html_theme = 'default' |
| 27 | + html_theme = "default" |
28 | 28 | else: |
29 | | - html_theme = 'nature' |
| 29 | + html_theme = "nature" |
30 | 30 |
|
31 | 31 | # -- General configuration ------------------------------------------------ |
32 | 32 |
|
|
37 | 37 | # Add any Sphinx extension module names here, as strings. They can be |
38 | 38 | # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom |
39 | 39 | # ones. |
40 | | -extensions = ['sphinx.ext.autodoc'] |
| 40 | +extensions = ["sphinx.ext.autodoc"] |
41 | 41 |
|
42 | 42 | # Add any paths that contain templates here, relative to this directory. |
43 | | -templates_path = ['_templates'] |
| 43 | +templates_path = ["_templates"] |
44 | 44 |
|
45 | 45 | # The suffix(es) of source filenames. |
46 | 46 | # You can specify multiple suffix as a list of string: |
47 | 47 | # |
48 | 48 | # source_suffix = ['.rst', '.md'] |
49 | | -source_suffix = '.rst' |
| 49 | +source_suffix = ".rst" |
50 | 50 |
|
51 | 51 | # The master toctree document. |
52 | | -master_doc = 'index' |
| 52 | +master_doc = "index" |
53 | 53 |
|
54 | 54 | # General information about the project. |
55 | | -project = 'Python Namesilo Module' |
56 | | -copyright = '2018, Goran Vrbaški' |
57 | | -author = 'Goran Vrbaški' |
| 55 | +project = "Python Namesilo Module" |
| 56 | +copyright = "2026, Goran Vrbaški" |
| 57 | +author = "Goran Vrbaški" |
58 | 58 |
|
59 | 59 | # The version info for the project you're documenting, acts as replacement for |
60 | 60 | # |version| and |release|, also used in various other places throughout the |
61 | 61 | # built documents. |
62 | 62 | # |
63 | 63 | # The short X.Y version. |
64 | | -version = '1.1.2' |
| 64 | +version = "2.0.0" |
65 | 65 | # The full version, including alpha/beta/rc tags. |
66 | | -release = '1.1.2' |
| 66 | +release = "2.0.0" |
67 | 67 |
|
68 | 68 | # The language for content autogenerated by Sphinx. Refer to documentation |
69 | 69 | # for a list of supported languages. |
|
75 | 75 | # List of patterns, relative to source directory, that match files and |
76 | 76 | # directories to ignore when looking for source files. |
77 | 77 | # This patterns also effect to html_static_path and html_extra_path |
78 | | -exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store'] |
| 78 | +exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"] |
79 | 79 |
|
80 | 80 | # The name of the Pygments (syntax highlighting) style to use. |
81 | | -pygments_style = 'sphinx' |
| 81 | +pygments_style = "sphinx" |
82 | 82 |
|
83 | 83 | # If true, `todo` and `todoList` produce output, else they produce nothing. |
84 | 84 | todo_include_todos = False |
|
89 | 89 | # The theme to use for HTML and HTML Help pages. See the documentation for |
90 | 90 | # a list of builtin themes. |
91 | 91 | # |
92 | | -html_theme = 'sphinx_rtd_theme' |
| 92 | +html_theme = "sphinx_rtd_theme" |
93 | 93 |
|
94 | 94 | # Theme options are theme-specific and customize the look and feel of a theme |
95 | 95 | # further. For a list of options available for each theme, see the |
|
100 | 100 | # Add any paths that contain custom static files (such as style sheets) here, |
101 | 101 | # relative to this directory. They are copied after the builtin static files, |
102 | 102 | # so a file named "default.css" will overwrite the builtin "default.css". |
103 | | -html_static_path = ['_static'] |
| 103 | +html_static_path = ["_static"] |
104 | 104 |
|
105 | 105 | # Custom sidebar templates, must be a dictionary that maps document names |
106 | 106 | # to template names. |
107 | 107 | # |
108 | 108 | # This is required for the alabaster theme |
109 | 109 | # refs: http://alabaster.readthedocs.io/en/latest/installation.html#sidebars |
110 | 110 | html_sidebars = { |
111 | | - '**': [ |
112 | | - 'about.html', |
113 | | - 'navigation.html', |
114 | | - 'relations.html', # needs 'show_related': True theme option to display |
115 | | - 'searchbox.html', |
116 | | - 'donate.html', |
| 111 | + "**": [ |
| 112 | + "about.html", |
| 113 | + "navigation.html", |
| 114 | + "relations.html", # needs 'show_related': True theme option to display |
| 115 | + "searchbox.html", |
| 116 | + "donate.html", |
117 | 117 | ] |
118 | 118 | } |
119 | 119 |
|
120 | 120 |
|
121 | 121 | # -- Options for HTMLHelp output ------------------------------------------ |
122 | 122 |
|
123 | 123 | # Output file base name for HTML help builder. |
124 | | -htmlhelp_basename = 'PythonNamesiloModuledoc' |
| 124 | +htmlhelp_basename = "PythonNamesiloModuledoc" |
125 | 125 |
|
126 | 126 |
|
127 | 127 | # -- Options for LaTeX output --------------------------------------------- |
|
130 | 130 | # The paper size ('letterpaper' or 'a4paper'). |
131 | 131 | # |
132 | 132 | # 'papersize': 'letterpaper', |
133 | | - |
134 | 133 | # The font size ('10pt', '11pt' or '12pt'). |
135 | 134 | # |
136 | 135 | # 'pointsize': '10pt', |
137 | | - |
138 | 136 | # Additional stuff for the LaTeX preamble. |
139 | 137 | # |
140 | 138 | # 'preamble': '', |
141 | | - |
142 | 139 | # Latex figure (float) alignment |
143 | 140 | # |
144 | 141 | # 'figure_align': 'htbp', |
|
148 | 145 | # (source start file, target name, title, |
149 | 146 | # author, documentclass [howto, manual, or own class]). |
150 | 147 | latex_documents = [ |
151 | | - (master_doc, 'PythonNamesiloModule.tex', 'Python Namesilo Module Documentation', |
152 | | - 'Goran Vrbaski', 'manual'), |
| 148 | + ( |
| 149 | + master_doc, |
| 150 | + "PythonNamesiloModule.tex", |
| 151 | + "Python Namesilo Module Documentation", |
| 152 | + "Goran Vrbaski", |
| 153 | + "manual", |
| 154 | + ), |
153 | 155 | ] |
154 | 156 |
|
155 | 157 |
|
|
158 | 160 | # One entry per manual page. List of tuples |
159 | 161 | # (source start file, name, description, authors, manual section). |
160 | 162 | man_pages = [ |
161 | | - (master_doc, 'pythonnamesilomodule', 'Python Namesilo Module Documentation', |
162 | | - [author], 1) |
| 163 | + ( |
| 164 | + master_doc, |
| 165 | + "pythonnamesilomodule", |
| 166 | + "Python Namesilo Module Documentation", |
| 167 | + [author], |
| 168 | + 1, |
| 169 | + ) |
163 | 170 | ] |
164 | 171 |
|
165 | 172 |
|
|
169 | 176 | # (source start file, target name, title, author, |
170 | 177 | # dir menu entry, description, category) |
171 | 178 | texinfo_documents = [ |
172 | | - (master_doc, 'PythonNamesiloModule', 'Python Namesilo Module Documentation', |
173 | | - author, 'PythonNamesiloModule', 'One line description of project.', |
174 | | - 'Miscellaneous'), |
| 179 | + ( |
| 180 | + master_doc, |
| 181 | + "PythonNamesiloModule", |
| 182 | + "Python Namesilo Module Documentation", |
| 183 | + author, |
| 184 | + "PythonNamesiloModule", |
| 185 | + "One line description of project.", |
| 186 | + "Miscellaneous", |
| 187 | + ), |
175 | 188 | ] |
176 | 189 |
|
177 | | -autoclass_content = 'both' |
| 190 | +autoclass_content = "both" |
0 commit comments