Skip to content

Reduce deployed docs size by not shipping .doctrees and removing exhaustive API listing from table of contents - #7696

Merged
jrhemstad merged 3 commits into
NVIDIA:mainfrom
jrhemstad:reduce-docs-size
Feb 17, 2026
Merged

jrhemstad merged 3 commits into
NVIDIA:mainfrom
jrhemstad:reduce-docs-size

Conversation

@jrhemstad

@jrhemstad jrhemstad commented Feb 17, 2026 •

Copy link
Copy Markdown
Collaborator

This reduces the size of our deployed docs by 300MB (from 421MB to 121MB)

  • Don't ship .doctrees as this is not needed for statically serving the docs
  • Don't include every symbol in table of contents as this massively inflates the size of each page

Before:

git clone --depth 1 --branch gh-pages https://github.com/NVIDIA/cccl.git /tmp/upstream-gh-pages && du -sh /tmp/upstream-gh-pages
421M	/tmp/upstream-gh-pages

After:

git clone --depth 1 --branch gh-pages [email protected]:jrhemstad/cccl.git /tmp/fork-gh-pages && du -sh /tmp/fork-gh-pages
121M	/tmp/fork-gh-pages

Before (example: https://nvidia.github.io/cccl/unstable/thrust/api/index.html)
image

After (example: https://jrhemstad.github.io/cccl/unstable/thrust/api/index.html)
image

@jrhemstad
jrhemstad requested a review from a team as a code owner February 17, 2026 16:01
@jrhemstad
jrhemstad requested a review from gonidelis February 17, 2026 16:01
@copy-pr-bot

copy-pr-bot Bot commented Feb 17, 2026

Copy link
Copy Markdown
Contributor

This pull request requires additional validation before any workflows can run on NVIDIA's runners.

Pull request vetters can view their responsibilities here.

Contributors can view more details about this message here.

@github-project-automation github-project-automation Bot moved this to Todo in CCCL Feb 17, 2026
@cccl-authenticator-app cccl-authenticator-app Bot moved this from Todo to In Review in CCCL Feb 17, 2026
@jrhemstad
jrhemstad merged commit 2ea0d8d into NVIDIA:main Feb 17, 2026
6 checks passed
@github-project-automation github-project-automation Bot moved this from In Review to Done in CCCL Feb 17, 2026
fbusato pushed a commit to fbusato/cccl that referenced this pull request Feb 19, 2026
…haustive API listing from table of contents (NVIDIA#7696)

* Update Sphinx documentation build command to specify doctree directory to avoid deploying doctrees in gh-pages

* Add :orphan: directive to auto-generated API documentation pages to avoid bloating doc size with full symbol list in TOC tree.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Archived in project

Development

Successfully merging this pull request may close these issues.

2 participants