mirror of
https://github.com/edgewall/genshi.git
synced 2026-02-05 15:46:37 +01:00
3b7bf4c23b
* Add basic Sphinx configuration. * Translate documentation to Sphinx .rst * Add doc/_build to gitignore. * Rename requirements.rst back to .txt. * Fix HTMLFormFiller reference. * Caption the toctree sections. * Switch to the RTD Sphinx theme. * Add API documentation. * Dowgrade Sphinx to 7.4 for sphinx-rtd-theme. * Update Read the Docs badge to point to genshi-edgewall.readthedocs.org.
41 lines
1.2 KiB
Python
41 lines
1.2 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 = "Genshi"
|
|
copyright = "2024, Edgewall Software"
|
|
author = "Edgewall Software"
|
|
release = "0.8"
|
|
|
|
# -- General configuration ---------------------------------------------------
|
|
# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
|
|
|
|
extensions = [
|
|
"sphinx.ext.autodoc",
|
|
"sphinx.ext.viewcode",
|
|
]
|
|
|
|
templates_path = ["_templates"]
|
|
exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
|
|
|
|
modindex_common_prefix = ["genshi."]
|
|
autodoc_default_options = {
|
|
"members": True,
|
|
}
|
|
autodoc_preserve_defaults = True
|
|
|
|
# -- Options for HTML output -------------------------------------------------
|
|
# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
|
|
|
|
html_theme = "sphinx_rtd_theme"
|
|
html_static_path = ["_static"]
|
|
html_theme_options = {
|
|
"collapse_navigation": True,
|
|
"sticky_navigation": True,
|
|
"navigation_depth": 4,
|
|
}
|