royalnet/docs_source/conf.py

# 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:
# http://www.sphinx-doc.org/en/master/config

# -- 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('.'))

import royalnet

# -- Project information -----------------------------------------------------

project = 'Royalnet'
copyright = '2019, Stefano Pigozzi'
author = 'Stefano Pigozzi'
version = royalnet.__version__
release = royalnet.__version__

# -- 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 = [
    "sphinx.ext.autodoc",
    "sphinx.ext.napoleon",
    "sphinx.ext.intersphinx",
]

intersphinx_mapping = {
    "python": ("https://docs.python.org/3.8", None),
    "keyring": ("https://keyring.readthedocs.io/en/latest/", None),
    "telegram": ("https://python-telegram-bot.readthedocs.io/en/stable/", None),
    "discord": ("https://discordpy.readthedocs.io/en/latest/", None),
    "ffmpeg_python": ("https://kkroening.github.io/ffmpeg-python/", None),
    "sqlalchemy": ("https://docs.sqlalchemy.org/en/13/", None),
    "psycopg2": ("http://initd.org/psycopg/docs/", None),
    "websockets": ("https://websockets.readthedocs.io/en/stable/", None),
}


def skip(app, what, name: str, obj, would_skip, options):
    if name == "__init__" or name == "__getitem__" or name == "__getattr__":
        return not bool(obj.__doc__)
    return would_skip


def setup(app):
    app.connect("autodoc-skip-member", skip)
    app.add_stylesheet('rygdocs.css')


# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']

# 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.
exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']


# -- Options for HTML output -------------------------------------------------

# The theme to use for HTML and HTML Help pages.  See the documentation for
# a list of builtin themes.
#
html_theme = 'sphinx_rtd_theme'

# 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,
# so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ['_static']

# Display warnings on the pages... for now.
keep_warnings = True
nitpicky = True