Skip to content

docs: enable public_docs_features for NRL Sphinx build#2233

Closed
kheiss-uwzoo wants to merge 5 commits into
NVIDIA:mainfrom
kheiss-uwzoo:docs/public-docs-features
Closed

docs: enable public_docs_features for NRL Sphinx build#2233
kheiss-uwzoo wants to merge 5 commits into
NVIDIA:mainfrom
kheiss-uwzoo:docs/public-docs-features

Conversation

@kheiss-uwzoo

Copy link
Copy Markdown
Collaborator

Summary

Per NVIDIA Sphinx Theme guidance (Nathan), enable built-in public documentation features for the NRL docs build instead of maintaining custom analytics and feedback template overrides.

  • Add public_docs_features: True and copyright_override: {start: 2023} to html_theme_options in docs/sphinx_docs/source/conf.py. The project already uses nvidia_sphinx_theme, so this option adds the required footer links and scripts to generated Sphinx HTML pages.
  • Remove manual footer_links from conf.py because the theme supplies Privacy Policy and Terms of Use when public_docs_features is enabled.
  • Remove Adobe DTM, Hotjar feedback, and _satellite.pageBottom() injections from docs/overrides/main.html. These features are included automatically when public_docs_features is enabled on the Sphinx side.
  • Delete the obsolete docs/overrides-nrl-staging/main.html workaround that existed only to omit analytics on staging GitHub Pages builds.

Test plan

  • mkdocs build -f mkdocs.yml --strict completes successfully
  • Built MkDocs HTML contains no adobedtm, hotjar, or _satellite references
  • Full Sphinx pipeline (make docs / CI) verified after merge — requires openapi.yaml generation step in the full docs build

EOF

Enable NVIDIA Sphinx Theme public docs features (footer links, analytics scripts) and remove redundant MkDocs Adobe DTM and Hotjar template overrides.
@kheiss-uwzoo kheiss-uwzoo requested review from a team as code owners June 11, 2026 22:43
@kheiss-uwzoo kheiss-uwzoo requested a review from jioffe502 June 11, 2026 22:43
@greptile-apps

greptile-apps Bot commented Jun 11, 2026

Copy link
Copy Markdown
Contributor

Greptile Summary

This PR migrates the NRL Sphinx docs build to use nvidia_sphinx_theme's built-in public_docs_features, removing manual Adobe DTM, Hotjar, and footer-link template overrides that the theme now manages automatically.

  • conf.py gains public_docs_features: True and copyright_override: {start: 2023}, the explicit footer_links block is dropped, and the header_links GitHub URL is corrected from nvidia-sphinx-theme to NeMo-Retriever.
  • docs/overrides/main.html and docs/overrides-nrl-staging/main.html are deleted; the latter's .icons subdirectory remains on disk but is now unreferenced by any config.

Confidence Score: 5/5

Safe to merge — all changes are documentation build configuration only, with no runtime code affected.

The change removes manually maintained template overrides and delegates analytics, privacy links, and feedback injection to the upstream NVIDIA Sphinx theme. No business logic, API contracts, or Python source files are touched. The GitHub Pages workflow and MkDocs build both remain unchanged. The only loose end is docs/overrides-nrl-staging/.icons/ staying on disk as dead files, which has no functional impact.

No files require special attention.

Important Files Changed

Filename Overview
docs/sphinx_docs/source/conf.py Adds public_docs_features and copyright_override; removes footer_links; fixes GitHub header link to point at NeMo-Retriever.
docs/overrides/main.html Deleted: removed Adobe DTM script, Hotjar survey link, and _satellite.pageBottom() injection — all now handled by the theme when public_docs_features is enabled.
docs/overrides-nrl-staging/main.html Deleted: staging workaround that suppressed analytics on GitHub Pages builds; now unnecessary since analytics injection has moved to the theme.

Flowchart

%%{init: {'theme': 'neutral'}}%%
flowchart TD
    A[Sphinx Build] --> B{html_theme = nvidia_sphinx_theme}
    B --> C[public_docs_features: True]
    C --> D[Theme injects: Privacy Policy & Terms of Use footer]
    C --> E[Theme injects: Adobe DTM analytics]
    C --> F[Theme injects: Hotjar feedback]

    G[MkDocs Build] --> H{custom_dir: overrides}
    H --> I[overrides/.icons — still present]
    H --> J[overrides/main.html — DELETED]
    J --> K[MkDocs uses built-in main.html]

    L[overrides-nrl-staging/main.html — DELETED] -.->|was a staging-only analytics suppressor| J
Loading

Reviews (5): Last reviewed commit: "Merge branch 'main' into docs/public-doc..." | Re-trigger Greptile

Comment thread docs/sphinx_docs/source/conf.py Outdated
Comment thread docs/overrides/main.html Outdated
@kheiss-uwzoo kheiss-uwzoo self-assigned this Jun 11, 2026
@kheiss-uwzoo kheiss-uwzoo marked this pull request as draft June 11, 2026 23:10
@kheiss-uwzoo kheiss-uwzoo marked this pull request as ready for review June 15, 2026 19:07
@kheiss-uwzoo

Copy link
Copy Markdown
Collaborator Author

Combined into #2223 — merged \docs/public-docs-features\ into \ci/nrl-docs-nvidia-publish.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant