Merge pull request #67 from python-project-templates/tkp/red

Add sphinx-reredirect support, fixes #63

Author: timkpaine

pyproject.toml

@@ -172,3 +172,6 @@ autodoc_pydantic_model_member_order = "bysource"
 autodoc_pydantic_model_show_json = true
 autodoc_pydantic_settings_show_json = false
 autodoc_pydantic_model_show_field_summary = false
+
+# redirects
+redirects = {"docs/src/testredirect"="home.html", "toplevel"="docs/src/home.html"}

yardang/build.py

@@ -116,6 +116,8 @@ def generate_docs_configuration(
             "autodoc_pydantic_model_show_json": True,
             "autodoc_pydantic_settings_show_json": None,
             "autodoc_pydantic_model_show_field_summary": None,
+            # sphinx-reredirects
+            "redirects": {},
         }.items():
             configuration_args[config_option] = get_config(section=config_option, base=config_base) or default
 

yardang/conf.py.j2

@@ -38,6 +38,7 @@ extensions = [
     "sphinx.ext.inheritance_diagram",
     "sphinxcontrib.mermaid",
     "sphinxcontrib.autodoc_pydantic",
+    "sphinx_reredirects",
 ]
 if use_autoapi in (True, None):
     # add if it is set to true or if it is set to None
@@ -82,6 +83,9 @@ nb_execution_excludepatterns = {{nb_execution_excludepatterns}}
 #sphinxcontrib.mermaid
 mermaid_d3_zoom = True
 
+# redirects
+redirects = {{redirects}}
+
 # autosummary
 autosummary_generate = True