Skip to content

Add sitemap config #1079

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 3 commits into from
Dec 1, 2025
Merged

Add sitemap config #1079

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
68207f9
Add sitemap config
NicolasHug Nov 28, 2025
75e7774
update requirements.txt
NicolasHug Nov 28, 2025
f21917b
Merge branch 'main' into sitemap
NicolasHug Dec 1, 2025
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
1 change: 1 addition & 0 deletions docs/requirements.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ sphinx==5.0.0
sphinx_design
sphinx_copybutton
sphinx-tabs
sphinx-sitemap
matplotlib
torchvision
ipython
Expand Down
10 changes: 10 additions & 0 deletions docs/source/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,7 @@
"sphinx_tabs.tabs",
"sphinx_design",
"sphinx_copybutton",
"sphinx_sitemap",
]


Expand Down Expand Up @@ -216,6 +217,15 @@ def __call__(self, filename):
"matplotlib": ("https://matplotlib.org/stable/", None),
}

# sitemap config
html_baseurl = "https://meta-pytorch.org/torchcodec/stable/"
sitemap_locales = [None]
sitemap_excludes = [
"search.html",
"genindex.html",
]
sitemap_url_scheme = "{link}"


def inject_minigalleries(app, what, name, obj, options, lines):
"""Inject a minigallery into a docstring.
Expand Down
Loading