5c3c42d6b3
this has 100% test coverage and i intend to keep it that way. api docs have a good start but still need narrative. several more things must be added before i can seriously consider incorporating into rattail but this seemed a good save point
39 lines
1.3 KiB
Python
39 lines
1.3 KiB
Python
# Configuration file for the Sphinx documentation builder.
|
|
#
|
|
# For the full list of built-in configuration values, see the documentation:
|
|
# https://www.sphinx-doc.org/en/master/usage/configuration.html
|
|
|
|
# -- Project information -----------------------------------------------------
|
|
# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
|
|
|
|
project = 'WuttJamaican'
|
|
copyright = '2023, Lance Edgar'
|
|
author = 'Lance Edgar'
|
|
release = '0.1'
|
|
|
|
# -- General configuration ---------------------------------------------------
|
|
# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
|
|
|
|
extensions = [
|
|
'sphinx.ext.autodoc',
|
|
'sphinx.ext.intersphinx',
|
|
'sphinx.ext.todo',
|
|
]
|
|
|
|
templates_path = ['_templates']
|
|
exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
|
|
|
|
intersphinx_mapping = {
|
|
'python-configuration': ('https://python-configuration.readthedocs.io/en/latest/', None),
|
|
'rattail': ('https://rattailproject.org/docs/rattail/', None),
|
|
'rattail-manual': ('https://rattailproject.org/docs/rattail-manual/', None),
|
|
'sqlalchemy': ('http://docs.sqlalchemy.org/en/latest/', None),
|
|
}
|
|
|
|
|
|
# -- Options for HTML output -------------------------------------------------
|
|
# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
|
|
|
|
html_theme = 'alabaster'
|
|
html_static_path = ['_static']
|