boticordpy/docs/source/conf.py

79 lines
2.3 KiB
Python
Raw Normal View History

2021-08-24 21:20:10 +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.
#
2022-02-17 19:14:39 +03:00
# import os
# import sys
# sys.path.insert(0, os.path.abspath('.'))
2021-08-24 21:20:10 +03:00
# -- Project information -----------------------------------------------------
2022-02-17 19:14:39 +03:00
import sys
import os
2021-08-24 21:20:10 +03:00
2022-02-17 19:14:39 +03:00
sys.path.insert(0, os.path.abspath("../.."))
2022-09-10 15:00:26 +03:00
project = "BoticordPY"
2023-06-04 12:21:28 +03:00
copyright = "2022 - 2023, Viktor K (Marakarka)"
author = "Viktor K (Marakarka)"
2022-02-17 19:14:39 +03:00
# The full version, including alpha/beta/rc tags
2023-06-04 12:21:28 +03:00
release = "3.0.0a"
2021-08-24 21:20:10 +03:00
# -- General configuration ---------------------------------------------------
# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = [
2023-06-04 12:21:28 +03:00
"sphinx_design",
2022-02-17 19:14:39 +03:00
"sphinx.ext.napoleon",
"sphinx.ext.autodoc",
"sphinx.ext.viewcode",
"sphinx.ext.autosectionlabel",
"sphinx.ext.extlinks",
2023-06-04 12:21:28 +03:00
"sphinxcontrib_trio"
2021-08-24 21:20:10 +03:00
]
2023-06-04 12:21:28 +03:00
autodoc_default_options = {"members": True, "show-inheritance": True, 'member-order': 'bysource'}
2021-08-24 21:20:10 +03:00
# Add any paths that contain templates here, relative to this directory.
2022-09-10 15:00:26 +03:00
templates_path = ["_templates"]
2021-08-24 21:20:10 +03:00
2023-06-04 12:21:28 +03:00
add_module_names = False
2022-02-17 19:14:39 +03:00
exclude_patterns = []
2021-08-24 21:20:10 +03:00
2022-02-17 19:14:39 +03:00
intersphinx_mapping = {
"py": ("https://docs.python.org/3", None),
"aiohttp": ("https://docs.aiohttp.org/en/stable/", None),
}
2021-08-24 21:20:10 +03:00
# -- Options for HTML output -------------------------------------------------
2023-06-04 12:21:28 +03:00
html_theme = "furo"
html_theme_options = {
"sidebar_hide_name": True,
}
pygments_style = "monokai"
default_dark_mode = True
2022-09-10 15:00:26 +03:00
html_static_path = ["_static"]
2023-06-04 12:21:28 +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
"""