Skip to content

Match ecosystem-wide Sphinx doc footer convention #12

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
petercorke merged 1 commit into from
Sep 3, 2026
Merged

Match ecosystem-wide Sphinx doc footer convention #12

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions docs/source/_static/custom.css
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
/* Footer layout: copyright on the left, GitHub link on the right in smaller font. */
div[role="contentinfo"] {
display: flex;
justify-content: space-between;
align-items: baseline;
flex-wrap: wrap;
}

div[role="contentinfo"] p {
margin: 0;
}

.footer-github-link {
font-size: 0.85em;
}
13 changes: 13 additions & 0 deletions docs/source/_templates/footer.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
{% extends "!footer.html" %}
{% block contentinfo %}
<p>
{%- if show_copyright %}
{%- trans copyright=copyright|e %}Copyright &#169; {{ copyright }}{% endtrans -%}
{%- endif %}
{%- if last_updated %}
{%- trans last_updated=last_updated|e %}: built {{ last_updated }}{% endtrans %}
{%- endif -%}
.
</p>
<a href="https://github.com/petercorke/pgraph-python" class="footer-github-link">GitHub</a>
{% endblock %}
5 changes: 3 additions & 2 deletions docs/source/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
# -- Project information -----------------------------------------------------

project = "Simple graph functionality for Python"
copyright = "2020, Peter Corke"
copyright = "2020-present, Peter Corke"
author = "Peter Corke"


Expand Down Expand Up @@ -80,10 +80,11 @@
#
html_theme = "sphinx_rtd_theme"
html_show_sourcelink = True
html_last_updated_fmt = "%d-%b-%Y"
html_last_updated_fmt = "%Y-%m-%d"
show_authors = True

# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ["_static"]
html_css_files = ["custom.css"]
Loading