boticordpy/docs/source/conf.py

77 lines
2.4 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"
copyright = "2022, Victor Kotlin (Marakarka)"
author = "Victor Kotlin (Marakarka)"
2022-02-17 19:14:39 +03:00
# The full version, including alpha/beta/rc tags
2022-09-10 16:35:56 +03:00
release = "2.2.2"
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 = [
2022-02-17 19:14:39 +03:00
"sphinx.ext.napoleon",
"sphinx.ext.autodoc",
"sphinx.ext.viewcode",
"sphinx.ext.autosectionlabel",
"sphinx.ext.extlinks",
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
# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
# This pattern also affects html_static_path and html_extra_path.
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),
"discord": ("https://discordpy.readthedocs.io/en/latest/", None),
"aiohttp": ("https://docs.aiohttp.org/en/stable/", None),
}
2021-08-24 21:20:10 +03:00
# -- Options for HTML output -------------------------------------------------
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
#
2022-09-10 15:00:26 +03:00
html_theme = "sphinxawesome_theme"
2022-02-17 19:14:39 +03:00
2022-09-10 15:00:26 +03:00
html_theme_options = {}
2021-08-24 21:20:10 +03:00
# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
2022-02-17 19:14:39 +03:00
# so a file named "custom.css" will overwrite the builtin "custom.css".
2022-09-10 15:00:26 +03:00
html_static_path = ["_static"]
2022-02-17 19:14:39 +03:00
def setup(app):
2022-09-10 15:00:26 +03:00
app.add_css_file("custom.css")