diff options
Diffstat (limited to '')
-rw-r--r-- | docs/conf.py | 58 |
1 files changed, 58 insertions, 0 deletions
diff --git a/docs/conf.py b/docs/conf.py new file mode 100644 index 0000000..22bbe11 --- /dev/null +++ b/docs/conf.py @@ -0,0 +1,58 @@ +"""A sphinx documentation configuration file. +""" + +# -- Project information --------------------------------------------------------------- +# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information + +project = "installer" + +copyright = "2020, Pradyun Gedam" +author = "Pradyun Gedam" + +# -- General configuration ------------------------------------------------------------- +# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration + +extensions = [ + "sphinx.ext.autodoc", + "sphinx.ext.doctest", + "sphinx.ext.intersphinx", + "sphinx.ext.todo", + "myst_parser", + "sphinxarg.ext", +] + +# -- Options for HTML output ----------------------------------------------------------- +# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output + +html_theme = "furo" +html_title = project + +# -- Options for Autodoc -------------------------------------------------------------- +# https://www.sphinx-doc.org/en/master/usage/extensions/autodoc.html#configuration + +autodoc_member_order = "bysource" +autodoc_preserve_defaults = True + +# Keep the type hints outside the function signature, moving them to the +# descriptions of the relevant function/methods. +autodoc_typehints = "description" + +# Don't show the class signature with the class name. +autodoc_class_signature = "separated" + +# -- Options for intersphinx ---------------------------------------------------------- +# https://www.sphinx-doc.org/en/master/usage/extensions/intersphinx.html#configuration + +intersphinx_mapping = { + "python": ("https://docs.python.org/3", None), + "pypug": ("https://packaging.python.org", None), +} + +# -- Options for Markdown files -------------------------------------------------------- +# https://myst-parser.readthedocs.io/en/latest/sphinx/reference.html + +myst_enable_extensions = [ + "colon_fence", + "deflist", +] +myst_heading_anchors = 3 |