#235 - Stop shadowing MkDocs Material base template - #236
Conversation
Signed-off-by: Denis Leshchev <dleshchev@nvidia.com>
|
| Filename | Overview |
|---|---|
| overrides/base.html | Deleted: was a verbatim copy of MkDocs Material's generated template with hardcoded CSS/JS asset hashes (e.g. main.484c7ddc.min.css, bundle.79ae519e.min.js) that caused link-check failures whenever the upstream theme regenerated those hashes. |
| overrides/main.html | Now extends the theme's built-in base.html and appends the repo-specific SVG and apple-touch-icon favicon links in the site_meta block via super(). The favicon-32.png PNG fallback from the old base.html is intentionally dropped. |
| scripts/check_html_links.py | Replaces a fragile regex (href-only) with a proper HTMLParser subclass that collects both href and src attributes, broadening the check to cover script and image references in the landing page. |
Reviews (1): Last reviewed commit: "#235 - Stop shadowing MkDocs Material ba..." | Re-trigger Greptile
Summary
overrides/base.htmlcopy so MkDocs Material supplies its current generated CSS/JS asset hashes.overrides/main.htmlon top of the theme base template.hrefandsrctargets so stale generated CSS or JS references are caught.Related Issue
Fixes #235.
Scope
This is limited to the docs CI/link-check failure. It does not include PR #234 changes and was branched from latest
origin/main.Base commit:
298efbdfcc299c2914b9c58ba28eab6c952bfde7(origin/main).Validation
make -C docs/images/packet_diagrams all/tmp/daqiri-docs-ci-venv/bin/mkdocs build --strict/tmp/daqiri-docs-ci-venv/bin/python scripts/check_html_links.py site/tmp/daqiri-docs-ci-venv/bin/python scripts/check_doc_refs.pyRisk
Low. The main behavioral change is that DAQIRI no longer shadows MkDocs Material's full generated
base.html; the local favicon additions are preserved throughoverrides/main.html. The updated checker is intentionally broader because it catches local generated-sitesrctargets as well ashreftargets.