Skip to content
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.

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

Add a sphinx extension to show last edit date for each published page #2393

Closed
stichbury opened this issue Mar 6, 2023 · 1 comment
Closed
Labels
Component: Documentation 📄 Issue/PR for markdown and API documentation

Comments

@stichbury
Copy link
Contributor

Description

I think there's a sphinx extension to add a note to each page so it's clear to the reader when the page was last updated and whether that was a major/minor change. I'm sure I've used one in the past, and found this Github repo, but it doesn't look like what I had enabled previously. Maybe that was when I was working on Jekyll instead.

It may be useful to include this while we're making some page improvements (and while we are still using Sphinx), so our readers can (a) see where pages are newer and (b) see where they're looking at legacy pages with a few minor tweaks or complete page rewrites/new pages.

There are some caveats to this such as when we change the name of each and every page to remove underscores, at which point it becomes less than useful.

Wanted to discuss whether it is worth adding this, but I don't see it as a high priority, just a useful "nice to have" add-on.

@stichbury
Copy link
Contributor Author

stichbury commented Feb 1, 2024

Done using an extension in #3547

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Component: Documentation 📄 Issue/PR for markdown and API documentation
Projects
None yet
Development

No branches or pull requests

1 participant