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 last edited date to source documents #1336

Open
willingc opened this issue Nov 3, 2023 · 1 comment
Open

Add a last edited date to source documents #1336

willingc opened this issue Nov 3, 2023 · 1 comment
Labels
type: enhancement A self-contained enhancement or new feature

Comments

@willingc
Copy link
Contributor

willingc commented Nov 3, 2023

We know that some docs are out of date. It would be helpful to display an accurate "last edited date" on a page.

@pradyunsg Any ideas on how to do that efficiently?

@pradyunsg
Copy link
Member

pradyunsg commented Nov 3, 2023

https://github.com/mgeier/sphinx-last-updated-by-git

https://github.com/jdillard/sphinx-gitstamp

Both of these extensions gather git information from the repo and inject that into the build. I still have a TODO over at Lutra to properly deep dive into this aspect and present it.

IIRC, the first one should be easier to place into the docs without theme changes, and the latter would be a better fit for something to integrate into a theme/via templates.

@pradyunsg pradyunsg added the type: enhancement A self-contained enhancement or new feature label Nov 5, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type: enhancement A self-contained enhancement or new feature
Projects
None yet
Development

No branches or pull requests

2 participants