|
28 | 28 |
|
29 | 29 |
|
30 | 30 | # -- General configuration ----------------------------------------------------- |
31 | | - |
32 | | -# If your documentation needs a minimal Sphinx version, state it here. |
33 | | -# needs_sphinx = '1.0' |
34 | | - |
35 | | -# Add any Sphinx extension module names here, as strings. They can be extensions |
36 | | -# coming with Sphinx (named 'sphinx.ext.*') or your custom ones. |
37 | 31 | extensions = [ |
| 32 | + "myst_parser", |
38 | 33 | "sphinx.ext.autodoc", |
39 | 34 | "sphinx.ext.viewcode", |
40 | 35 | "sphinx.ext.autosummary", |
41 | | - "sphinx.ext.doctest", |
42 | 36 | "sphinx.ext.intersphinx", |
43 | 37 | "sphinx.ext.extlinks", |
44 | 38 | "numpydoc", |
45 | 39 | "sphinx.ext.napoleon", |
46 | | - "myst_parser", |
47 | | - # "IPython.sphinxext.ipython_console_highlighting", |
48 | | - # "IPython.sphinxext.ipython_directive", |
49 | | - # "nbsphinx", |
50 | 40 | ] |
51 | 41 |
|
52 | 42 | extlinks = { |
53 | 43 | "issue": ("https://github.com/dcherian/flox/issues/%s", "GH#"), |
54 | 44 | "pr": ("https://github.com/dcherian/flox/pull/%s", "GH#"), |
55 | 45 | } |
56 | 46 |
|
57 | | -# Add any paths that contain templates here, relative to this directory. |
58 | 47 | templates_path = ["_templates"] |
59 | | - |
60 | | -# The suffix of source filenames. |
61 | | -source_suffix = ".rst" |
62 | | - |
63 | | -# Enable notebook execution |
64 | | -# https://nbsphinx.readthedocs.io/en/0.4.2/never-execute.html |
65 | | -# nbsphinx_execute = 'auto' |
66 | | -# Allow errors in all notebooks by |
67 | | -nbsphinx_allow_errors = True |
68 | | - |
69 | | -# Disable cell timeout |
70 | | -nbsphinx_timeout = -1 |
71 | | - |
72 | | - |
73 | | -# The encoding of source files. |
74 | | -# source_encoding = 'utf-8-sig' |
75 | | - |
76 | | -# The master toctree document. |
| 48 | +source_suffix = [".rst", ".md"] |
77 | 49 | master_doc = "index" |
| 50 | +language = "en" |
78 | 51 |
|
79 | 52 | # General information about the project. |
80 | 53 | project = "flox" |
81 | 54 | current_year = datetime.datetime.now().year |
82 | | -copyright = f"2020-{current_year}, Deepak Cherian" |
| 55 | +copyright = f"2021-{current_year}, Deepak Cherian" |
83 | 56 | author = "Deepak Cherian" |
84 | 57 | # The version info for the project you're documenting, acts as replacement for |
85 | 58 | # |version| and |release|, also used in various other places throughout the |
|
90 | 63 | # The full version, including alpha/beta/rc tags. |
91 | 64 | release = flox.__version__ |
92 | 65 |
|
93 | | -# The language for content autogenerated by Sphinx. Refer to documentation |
94 | | -# for a list of supported languages. |
95 | | -# language = None |
96 | | - |
97 | 66 | # There are two options for replacing |today|: either, you set today to some |
98 | 67 | # non-false value, then it is used: |
99 | 68 | # today = '' |
|
121 | 90 | # The name of the Pygments (syntax highlighting) style to use. |
122 | 91 | pygments_style = "sphinx" |
123 | 92 |
|
124 | | -# A list of ignored prefixes for module index sorting. |
125 | | -# modindex_common_prefix = [] |
126 | | - |
127 | | -# If true, keep warnings as "system message" paragraphs in the built documents. |
128 | | -# keep_warnings = False |
129 | | - |
130 | 93 |
|
131 | 94 | # -- Options for HTML output --------------------------------------------------- |
132 | 95 |
|
133 | | -# The theme to use for HTML and HTML Help pages. See the documentation for |
134 | | -# a list of builtin themes. |
135 | | -html_theme = "sphinx_book_theme" |
| 96 | +html_theme = "furo" |
136 | 97 |
|
137 | 98 | # Theme options are theme-specific and customize the look and feel of a theme |
138 | 99 | # further. For a list of options available for each theme, see the |
|
142 | 103 | # Add any paths that contain custom themes here, relative to this directory. |
143 | 104 | # html_theme_path = [] |
144 | 105 |
|
145 | | -# The name for this set of Sphinx documents. If None, it defaults to |
146 | | -# "<project> v<release> documentation". |
147 | | -# html_title = None |
148 | | - |
149 | | -# A shorter title for the navigation bar. Default is the same as html_title. |
150 | | -# html_short_title = None |
| 106 | +html_title = "flox" |
151 | 107 |
|
152 | 108 | # The name of an image file (relative to this directory) to place at the top |
153 | 109 | # of the sidebar. |
|
161 | 117 | # Add any paths that contain custom static files (such as style sheets) here, |
162 | 118 | # relative to this directory. They are copied after the builtin static files, |
163 | 119 | # so a file named "default.css" will overwrite the builtin "default.css". |
164 | | -html_static_path = ["_static"] |
| 120 | +# html_static_path = ["_static"] |
165 | 121 |
|
166 | 122 | # If not '', a 'Last updated on:' timestamp is inserted at every page bottom, |
167 | 123 | # using the given strftime format. |
|
201 | 157 | # base URL from which the finished HTML is served. |
202 | 158 | # html_use_opensearch = '' |
203 | 159 |
|
204 | | -# This is the file name suffix for HTML files (e.g. ".xhtml"). |
205 | | -# html_file_suffix = None |
206 | | - |
207 | 160 | # Output file base name for HTML help builder. |
208 | 161 | htmlhelp_basename = "floxdoc" |
209 | 162 |
|
210 | | - |
211 | | -# -- Options for LaTeX output -------------------------------------------------- |
212 | | - |
213 | | -latex_elements = { |
214 | | - # The paper size ('letterpaper' or 'a4paper'). |
215 | | - # 'papersize': 'letterpaper', |
216 | | - # The font size ('10pt', '11pt' or '12pt'). |
217 | | - # 'pointsize': '10pt', |
218 | | - # Additional stuff for the LaTeX preamble. |
219 | | - # 'preamble': '', |
220 | | -} |
221 | | - |
222 | | -# Grouping the document tree into LaTeX files. List of tuples |
223 | | -# (source start file, target name, title, author, documentclass [howto/manual]). |
224 | | -latex_documents = [ |
225 | | - ("index", "flox.tex", "flox Documentation", "Deepak Cherian", "manual"), |
226 | | -] |
227 | | - |
228 | | -# The name of an image file (relative to this directory) to place at the top of |
229 | | -# the title page. |
230 | | -# latex_logo = None |
231 | | - |
232 | | -# For "manual" documents, if this is true, then toplevel headings are parts, |
233 | | -# not chapters. |
234 | | -# latex_use_parts = False |
235 | | - |
236 | | -# If true, show page references after internal links. |
237 | | -# latex_show_pagerefs = False |
238 | | - |
239 | | -# If true, show URL addresses after external links. |
240 | | -# latex_show_urls = False |
241 | | - |
242 | | -# Documents to append as an appendix to all manuals. |
243 | | -# latex_appendices = [] |
244 | | - |
245 | | -# If false, no module index is generated. |
246 | | -# latex_domain_indices = True |
247 | | - |
248 | | - |
249 | | -# -- Options for manual page output -------------------------------------------- |
250 | | - |
251 | | -# One entry per manual page. List of tuples |
252 | | -# (source start file, name, description, authors, manual section). |
253 | | -man_pages = [("index", "flox", "flox Documentation", [author], 1)] |
254 | | - |
255 | | -# If true, show URL addresses after external links. |
256 | | -# man_show_urls = False |
257 | | - |
258 | | - |
259 | | -# -- Options for Texinfo output ------------------------------------------------ |
260 | | - |
261 | | -# Grouping the document tree into Texinfo files. List of tuples |
262 | | -# (source start file, target name, title, author, |
263 | | -# dir menu entry, description, category) |
264 | | -texinfo_documents = [ |
265 | | - ( |
266 | | - "index", |
267 | | - "flox", |
268 | | - "flox Documentation", |
269 | | - author, |
270 | | - "flox", |
271 | | - "One line description of project.", |
272 | | - "Miscellaneous", |
273 | | - ), |
274 | | -] |
275 | | - |
276 | | -# Documents to append as an appendix to all manuals. |
277 | | -# texinfo_appendices = [] |
278 | | - |
279 | | -# If false, no module index is generated. |
280 | | -# texinfo_domain_indices = True |
281 | | - |
282 | | -# How to display URL addresses: 'footnote', 'no', or 'inline'. |
283 | | -# texinfo_show_urls = 'footnote' |
284 | | - |
285 | | -# If true, do not generate a @detailmenu in the "Top" node's menu. |
286 | | -# texinfo_no_detailmenu = False |
287 | 163 | intersphinx_mapping = { |
288 | 164 | "python": ("https://docs.python.org/3/", None), |
289 | 165 | "pandas": ("https://pandas.pydata.org/pandas-docs/stable", None), |
|
302 | 178 | napoleon_use_param = False |
303 | 179 | napoleon_use_rtype = False |
304 | 180 | napoleon_preprocess_types = True |
305 | | - |
306 | 181 | napoleon_type_aliases = { |
307 | 182 | # general terms |
308 | 183 | "sequence": ":term:`sequence`", |
|
0 commit comments