rattail-manual/docs/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:
# 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('.'))


# TODO: not sure why i had to explicitly declare this for the sake of buildbot,
# when it worked for me fine locally without doing this.
master_doc = 'index'


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

project = 'Rattail Manual'
copyright = '2021-2023, Lance Edgar'
author = 'Lance Edgar'


# -- 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.intersphinx',
    'sphinx.ext.todo',
]

intersphinx_mapping = {
    'alembic': ('https://alembic.sqlalchemy.org/en/latest/', None),
    'rattail': ('https://rattailproject.org/docs/rattail/', None),
    'tailbone': ('https://rattailproject.org/docs/tailbone/', None),
    'wuttjamaican': ('https://rattailproject.org/docs/wuttjamaican/', None),
}

# 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 = 'furo'

# 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']


# -- Lance extra stuff -------------------------------------------------------

# allow todo entries to show up
todo_include_todos = True