Skip to content

[chore] Automate creation of release notes toc #1155

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 7 commits into from
Oct 23, 2025
Merged

[chore] Automate creation of release notes toc #1155

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
d513f0f
[chore] Automate creation of release notes toc
mdboom Oct 17, 2025
a1fa8a3
Add missing things
mdboom Oct 17, 2025
163c624
Improve TOCs
mdboom Oct 20, 2025
42e5cc8
Rename function
mdboom Oct 20, 2025
596ffba
Fix toctree sorting
mdboom Oct 20, 2025
705890b
Address comments in PR
mdboom Oct 21, 2025
475fa5c
Merge remote-tracking branch 'upstream/main' into auto-release-toc
mdboom Oct 23, 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
9 changes: 4 additions & 5 deletions cuda_bindings/docs/source/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,13 +9,11 @@

# -- Path setup --------------------------------------------------------------

# If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the
# documentation root, use os.path.abspath to make it absolute, like shown here.
import os
import sys
from pathlib import Path

# import sys
# sys.path.insert(0, os.path.abspath('.'))
sys.path.insert(0, str((Path(__file__).parents[3] / "cuda_python" / "docs" / "exts").absolute()))


# -- Project information -----------------------------------------------------
Expand All @@ -41,6 +39,7 @@
"myst_nb",
"enum_tools.autoenum",
"sphinx_copybutton",
"release_toc",
]

nb_execution_mode = "off"
Expand Down
36 changes: 2 additions & 34 deletions cuda_bindings/docs/source/release.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,38 +6,6 @@ Release Notes

.. toctree::
:maxdepth: 3
:glob:

13.0.3 <release/13.0.3-notes.rst>
13.0.2 <release/13.0.2-notes.rst>
13.0.1 <release/13.0.1-notes.rst>
13.0.0 <release/13.0.0-notes.rst>
12.9.4 <release/12.9.4-notes.rst>
12.9.3 <release/12.9.3-notes.rst>
12.9.2 <release/12.9.2-notes.rst>
12.9.1 <release/12.9.1-notes.rst>
12.9.0 <release/12.9.0-notes.rst>
12.8.0 <release/12.8.0-notes.rst>
12.6.2 <release/12.6.2-notes.rst>
12.6.1 <release/12.6.1-notes.rst>
12.6.0 <release/12.6.0-notes.rst>
12.5.0 <release/12.5.0-notes.rst>
12.4.0 <release/12.4.0-notes.rst>
12.3.0 <release/12.3.0-notes.rst>
12.2.1 <release/12.2.1-notes.rst>
12.2.0 <release/12.2.0-notes.rst>
12.1.0 <release/12.1.0-notes.rst>
12.0.0 <release/12.0.0-notes.rst>
11.8.7 <release/11.8.7-notes.rst>
11.8.6 <release/11.8.6-notes.rst>
11.8.5 <release/11.8.5-notes.rst>
11.8.4 <release/11.8.4-notes.rst>
11.8.3 <release/11.8.3-notes.rst>
11.8.2 <release/11.8.2-notes.rst>
11.8.1 <release/11.8.1-notes.rst>
11.8.0 <release/11.8.0-notes.rst>
11.7.1 <release/11.7.1-notes.rst>
11.7.0 <release/11.7.0-notes.rst>
11.6.1 <release/11.6.1-notes.rst>
11.6.0 <release/11.6.0-notes.rst>
11.5.0 <release/11.5.0-notes.rst>
11.4.0 <release/11.4.0-notes.rst>
release/*[0-9]-notes
8 changes: 4 additions & 4 deletions cuda_core/docs/source/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,12 +9,11 @@

# -- Path setup --------------------------------------------------------------

# If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the
# documentation root, use os.path.abspath to make it absolute, like shown here.
import os
import sys
from pathlib import Path

# sys.path.insert(0, os.path.abspath('.'))
sys.path.insert(0, str((Path(__file__).parents[3] / "cuda_python" / "docs" / "exts").absolute()))


# -- Project information -----------------------------------------------------
Expand All @@ -41,6 +40,7 @@
"enum_tools.autoenum",
"sphinx_copybutton",
"sphinx_toolbox.more_autodoc.autoprotocol",
"release_toc",
]

# Add any paths that contain templates here, relative to this directory.
Expand Down
9 changes: 2 additions & 7 deletions cuda_core/docs/source/release.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,6 @@ Release Notes

.. toctree::
:maxdepth: 3
:glob:

0.4.0 <release/0.4.0-notes>
0.3.2 <release/0.3.2-notes>
0.3.1 <release/0.3.1-notes>
0.3.0 <release/0.3.0-notes>
0.2.0 <release/0.2.0-notes>
0.1.1 <release/0.1.1-notes>
0.1.0 <release/0.1.0-notes>
release/*[0-9]-notes
9 changes: 4 additions & 5 deletions cuda_pathfinder/docs/source/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,13 +9,11 @@

# -- Path setup --------------------------------------------------------------

# If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the
# documentation root, use os.path.abspath to make it absolute, like shown here.
import os
import sys
from pathlib import Path

# import sys
# sys.path.insert(0, os.path.abspath('.'))
sys.path.insert(0, str((Path(__file__).parents[3] / "cuda_python" / "docs" / "exts").absolute()))


# -- Project information -----------------------------------------------------
Expand All @@ -41,6 +39,7 @@
"myst_nb",
"enum_tools.autoenum",
"sphinx_copybutton",
"release_toc",
]

nb_execution_mode = "off"
Expand Down
10 changes: 2 additions & 8 deletions cuda_pathfinder/docs/source/release.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,12 +6,6 @@ Release Notes

.. toctree::
:maxdepth: 3
:glob:

1.3.1 <release/1.3.1-notes>
1.3.0 <release/1.3.0-notes>
1.2.3 <release/1.2.3-notes>
1.2.2 <release/1.2.2-notes>
1.2.1 <release/1.2.1-notes>
1.2.0 <release/1.2.0-notes>
1.1.0 <release/1.1.0-notes>
1.0.0 <release/1.0.0-notes>
release/*[0-9]-notes
30 changes: 30 additions & 0 deletions cuda_python/docs/exts/release_toc.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
# SPDX-FileCopyrightText: Copyright (c) 2025 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
# SPDX-License-Identifier: LicenseRef-NVIDIA-SOFTWARE-LICENSE

from pathlib import Path

from packaging.version import Version
from sphinx.directives.other import TocTree


class TocTreeSorted(TocTree):
"""A toctree directive that sorts entries by version."""

def parse_content(self, toctree):
super().parse_content(toctree)

if not toctree["glob"]:
return
Copy link
Collaborator

@rwgk rwgk Oct 20, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we have a valid use case that needs this? — If not: maybe issue a warning, to guard against oversights, like typos?

Copy link
Contributor Author

@mdboom mdboom Oct 21, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The main toctree in each of the subprojects doesn't use glob, they list the files explicitly. We don't want to sort those. For example.


entries = toctree.get("entries", [])
if not entries:
return

entries = [(Version(Path(x[1]).name.removesuffix("-notes")), x[1]) for x in entries]
entries.sort(key=lambda x: x[0], reverse=True)
entries = [(str(x[0]), x[1]) for x in entries]
toctree["entries"] = entries


def setup(app):
app.add_directive("toctree", TocTreeSorted, override=True)
9 changes: 4 additions & 5 deletions cuda_python/docs/source/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,13 +9,11 @@

# -- Path setup --------------------------------------------------------------

# If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the
# documentation root, use os.path.abspath to make it absolute, like shown here.
import os
import sys
from pathlib import Path

# import sys
# sys.path.insert(0, os.path.abspath('.'))
sys.path.insert(0, str((Path(__file__).parents[1] / "exts").absolute()))


# -- Project information -----------------------------------------------------
Expand All @@ -38,6 +36,7 @@
"sphinx.ext.napoleon",
"myst_nb",
"enum_tools.autoenum",
"release_toc",
]

# Add any paths that contain templates here, relative to this directory.
Expand Down
16 changes: 2 additions & 14 deletions cuda_python/docs/source/release.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,18 +6,6 @@ Release Notes

.. toctree::
:maxdepth: 3
:glob:

13.0.3 <release/13.0.3-notes.rst>
13.0.2 <release/13.0.2-notes.rst>
13.0.1 <release/13.0.1-notes.rst>
13.0.0 <release/13.0.0-notes.rst>
12.9.4 <release/12.9.4-notes.rst>
12.9.3 <release/12.9.3-notes.rst>
12.9.2 <release/12.9.2-notes.rst>
12.9.1 <release/12.9.1-notes.rst>
12.9.0 <release/12.9.0-notes.rst>
12.8.0 <release/12.8.0-notes.rst>
12.6.2 <release/12.6.2-notes.rst>
12.6.1 <release/12.6.1-notes.rst>
11.8.7 <release/11.8.7-notes.rst>
11.8.6 <release/11.8.6-notes.rst>
release/*[0-9]-notes
Loading