Skip to content

Add sphinx-reredirect support, fixes #63 #67

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Nov 19, 2025
Merged

Add sphinx-reredirect support, fixes #63 #67

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions pyproject.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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"}
2 changes: 2 additions & 0 deletions yardang/build.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
4 changes: 4 additions & 0 deletions yardang/conf.py.j2
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -82,6 +83,9 @@ nb_execution_excludepatterns = {{nb_execution_excludepatterns}}
#sphinxcontrib.mermaid
mermaid_d3_zoom = True

# redirects
redirects = {{redirects}}

# autosummary
autosummary_generate = True

Expand Down