docs: enable public_docs_features for NRL Sphinx build#2233
docs: enable public_docs_features for NRL Sphinx build#2233kheiss-uwzoo wants to merge 5 commits into
Conversation
Enable NVIDIA Sphinx Theme public docs features (footer links, analytics scripts) and remove redundant MkDocs Adobe DTM and Hotjar template overrides.
Greptile SummaryThis PR migrates the NRL Sphinx docs build to use
|
| 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
Reviews (5): Last reviewed commit: "Merge branch 'main' into docs/public-doc..." | Re-trigger Greptile
|
Combined into #2223 — merged \docs/public-docs-features\ into \ci/nrl-docs-nvidia-publish. |
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.
public_docs_features: Trueandcopyright_override: {start: 2023}tohtml_theme_optionsindocs/sphinx_docs/source/conf.py. The project already usesnvidia_sphinx_theme, so this option adds the required footer links and scripts to generated Sphinx HTML pages.footer_linksfromconf.pybecause the theme supplies Privacy Policy and Terms of Use whenpublic_docs_featuresis enabled._satellite.pageBottom()injections fromdocs/overrides/main.html. These features are included automatically whenpublic_docs_featuresis enabled on the Sphinx side.docs/overrides-nrl-staging/main.htmlworkaround that existed only to omit analytics on staging GitHub Pages builds.Test plan
mkdocs build -f mkdocs.yml --strictcompletes successfullyadobedtm,hotjar, or_satellitereferencesmake docs/ CI) verified after merge — requiresopenapi.yamlgeneration step in the full docs buildEOF