melisa/docs/source/conf.py

82 lines
2.1 KiB
Python
Raw Permalink Normal View History

2022-03-17 21:32:43 +03:00
# Configuration file for the Sphinx documentation builder.
#
# This file only contains a selection of the most common options. For a full
# list see the documentation:
# https://www.sphinx-doc.org/en/master/usage/configuration.html
# -- Path setup --------------------------------------------------------------
# If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the
# documentation root, use os.path.abspath to make it absolute, like shown here.
#
# import os
# import sys
# sys.path.insert(0, os.path.abspath('.'))
# -- Project information -----------------------------------------------------
import sys
import os
sys.path.append(os.path.abspath("../.."))
2022-06-30 22:29:10 +03:00
sys.path.append(os.path.abspath("extensions"))
2022-03-17 21:32:43 +03:00
2022-06-30 22:29:10 +03:00
project = "Melisa"
copyright = "2022, MelisaDev"
author = "MelisaDev"
2022-03-17 21:32:43 +03:00
# The full version, including alpha/beta/rc tags
2022-06-30 22:29:10 +03:00
release = "0.0.1a"
2022-03-17 21:32:43 +03:00
# -- General configuration ---------------------------------------------------
extensions = [
2022-06-30 22:29:10 +03:00
"sphinx_design",
2022-03-17 21:32:43 +03:00
"sphinx.ext.napoleon",
"sphinx.ext.autodoc",
"sphinx.ext.viewcode",
"sphinx.ext.autosectionlabel",
"sphinx.ext.extlinks",
"sphinxcontrib_trio",
2022-06-30 22:29:10 +03:00
"attributable",
2022-03-17 21:32:43 +03:00
]
2022-06-30 22:29:10 +03:00
autodoc_default_options = {"members": True, "show-inheritance": True}
2022-06-30 22:29:10 +03:00
autodoc_typehints = "none"
2022-03-17 21:32:43 +03:00
# Add any paths that contain templates here, relative to this directory.
2022-06-30 22:29:10 +03:00
templates_path = ["_templates"]
2022-03-17 21:32:43 +03:00
2022-03-21 23:33:49 +03:00
add_module_names = False
2022-03-17 21:32:43 +03:00
exclude_patterns = []
intersphinx_mapping = {
"py": ("https://docs.python.org/3", None),
"aiohttp": ("https://docs.aiohttp.org/en/stable/", None),
}
# -- Options for HTML output -------------------------------------------------
2022-06-30 22:29:10 +03:00
html_theme = "furo"
2022-03-17 21:32:43 +03:00
html_theme_options = {
"sidebar_hide_name": True,
}
2022-06-30 22:29:10 +03:00
pygments_style = "monokai"
2022-03-17 21:32:43 +03:00
default_dark_mode = True
2022-06-30 22:29:10 +03:00
html_static_path = ["_static"]
2022-03-17 21:32:43 +03:00
html_css_files = ["custom.css"]
rst_prolog = """
.. |coro| replace:: This function is a |coroutine_link|_.
.. |maybecoro| replace:: This function *could be a* |coroutine_link|_.
.. |coroutine_link| replace:: *coroutine*
.. _coroutine_link: https://docs.python.org/3/library/asyncio-task.html#coroutine
2022-03-21 23:33:49 +03:00
"""