Skip to content

Match ecosystem-wide Sphinx doc footer convention - #12

Merged
petercorke merged 1 commit into
mainfrom
docs/footer-convention
Sep 3, 2026
Merged

petercorke merged 1 commit into
mainfrom
docs/footer-convention

Conversation

@petercorke

Copy link
Copy Markdown
Owner

Summary

Per rvc-ecosystem AGENTS.md section 5: footer left side reads exactly Copyright © 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 "© 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.

Test plan

  • Real Sphinx build renders the exact expected footer text: Copyright © 2020-present, Peter Corke: built 2026-09-03. with the GitHub link correctly positioned via the loaded custom.css
  • 44/44 tests pass

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

codecov Bot commented Sep 3, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 85.20%. Comparing base (6c24cfe) to head (a9fc94a).

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.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@petercorke
petercorke merged commit f67cec7 into main Sep 3, 2026
11 checks passed
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