71 lines
1.8 KiB
Python
71 lines
1.8 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).
|
|
"""
|
|
|
|
import sys
|
|
import sphinx_rtd_theme
|
|
from pathlib import Path
|
|
|
|
|
|
project_root = Path(__file__).resolve().parent.parent
|
|
source_root = project_root / 'setclass'
|
|
doc_root = project_root / 'docs' / 'source'
|
|
sys.path.insert(0, source_root)
|
|
|
|
|
|
# -- Project information -----------------------------------------------------
|
|
# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
|
|
|
|
project = 'Setclass'
|
|
copyright = '2024, Jonathan Harker'
|
|
author = 'Jonathan Harker'
|
|
release = '0.1'
|
|
|
|
|
|
# -- General configuration ---------------------------------------------------
|
|
# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
|
|
|
|
extensions = [
|
|
'sphinx.ext.autodoc',
|
|
'sphinx.ext.todo',
|
|
'sphinx.ext.viewcode',
|
|
'sphinx.ext.intersphinx',
|
|
'sphinx.ext.mathjax',
|
|
'sphinx_rtd_theme',
|
|
'myst_parser',
|
|
]
|
|
|
|
intersphinx_mapping = {
|
|
'python': ('https://docs.python.org/3.12', None),
|
|
}
|
|
|
|
templates_path = ['_templates']
|
|
|
|
exclude_patterns = [
|
|
'_build',
|
|
'.DS_Store',
|
|
'.pytest_cache',
|
|
'.tox',
|
|
'.venv',
|
|
]
|
|
|
|
source_suffix = {
|
|
'.rst': 'restructuredtext',
|
|
'.md': 'markdown',
|
|
'.txt': 'markdown',
|
|
}
|
|
|
|
|
|
# -- Options for HTML output -------------------------------------------------
|
|
# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
|
|
html_theme = 'sphinx_rtd_theme'
|
|
html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
|
|
html_theme_options = {
|
|
'display_version': False,
|
|
'navigation_depth': 2,
|
|
'prev_next_buttons_location': 'None'
|
|
}
|
|
|
|
html_static_path = ['_static']
|