Match ecosystem-wide Sphinx doc footer convention - #12
Merged
Merged
Conversation
Per rvc-ecosystem AGENTS.md section 5: footer left side reads exactly
"Copyright (c) 20xx-present, Peter Corke: built YYYY-MM-DD", right
side is a smaller-font GitHub link back to the repo. Copies bdsim's
reference implementation (2026-08-16), the pair this convention was
established with:
- docs/source/_templates/footer.html: overrides sphinx_rtd_theme's
default footer (which reads "(c) Copyright ... Last updated on
DD-Mon-YYYY") with the exact left-side text, plus the GitHub link.
- docs/source/_static/custom.css: flexbox on the footer's
contentinfo div so the GitHub link actually renders on the right --
a plain <a> tag with no CSS just falls inline below the copyright
line.
Also fixes conf.py to match: copyright was "2020, Peter Corke" (no
"-present"), and html_last_updated_fmt was "%d-%b-%Y" instead of
"%Y-%m-%d" (the format the new footer template actually expects).
As a side effect this also resolves a pre-existing, unrelated build
warning: html_static_path already listed "_static" in conf.py, but
the directory didn't exist on disk, so every build warned "html_
static_path entry '_static' does not exist" -- creating the directory
for custom.css fixes that too.
Verified: real Sphinx build renders the exact expected footer text
("Copyright (c) 2020-present, Peter Corke: built 2026-09-03.") with
the GitHub link correctly positioned via the loaded custom.css.
Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #12 +/- ##
=======================================
Coverage 85.20% 85.20%
=======================================
Files 2 2
Lines 750 750
=======================================
Hits 639 639
Misses 111 111 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Per rvc-ecosystem
AGENTS.mdsection 5: footer left side reads exactlyCopyright © 20xx-present, Peter Corke: built YYYY-MM-DD, right side is a smaller-fontGitHublink back to the repo. Copies bdsim's reference implementation (2026-08-16), the pair this convention was established with:docs/source/_templates/footer.html: overridessphinx_rtd_theme's default footer (which reads "© Copyright ... Last updated on DD-Mon-YYYY") with the exact left-side text, plus the GitHub link.docs/source/_static/custom.css: flexbox on the footer'scontentinfodiv so the GitHub link actually renders on the right -- a plain<a>tag with no CSS just falls inline below the copyright line.Also fixes
conf.pyto match:copyrightwas"2020, Peter Corke"(no-present), andhtml_last_updated_fmtwas"%d-%b-%Y"instead of"%Y-%m-%d"(the format the new footer template actually expects).As a side effect this also resolves a pre-existing, unrelated build warning:
html_static_pathalready listed"_static"inconf.py, but the directory didn't exist on disk, so every build warned"html_static_path entry '_static' does not exist"-- creating the directory forcustom.cssfixes that too.Test plan
Copyright © 2020-present, Peter Corke: built 2026-09-03.with the GitHub link correctly positioned via the loadedcustom.css