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

Integrate into Sphinx core(?) #17

Open
AA-Turner opened this issue Aug 25, 2023 · 4 comments
Open

Integrate into Sphinx core(?) #17

AA-Turner opened this issue Aug 25, 2023 · 4 comments

Comments

@AA-Turner
Copy link
Contributor

Hi Jared (@jdillard),

I found out about this project after breaking it in Sphinx 7.2 -- sorry!

I wondered if you'd be amenable to integrating this as a first-party supported Sphinx extension -- either in the core directly or in @sphinx-doc. I wrote similar code for Python's PEP generation, so I can see the use-case.

If you'd prefer to keep this third-party, no worries -- the question arose as I was considering adding the feature to Sphinx core anyway, and it might make sense to capitalise on the work that you've done here.

Thanks,
Adam

@jdillard
Copy link
Owner

jdillard commented Aug 25, 2023

No worries!

I'd be happy if this functionality was a core part of Sphinx! Have you seen https://github.com/mgeier/sphinx-last-updated-by-git? I'm wondering if that would be a better implementation, not to mention @mgeier is a wizard (I've been following his development of that extension to improve my skills as I am an "assistant to the wizard" at best). He kind of talks about the differences between our two extensions here: mgeier/sphinx-last-updated-by-git#34 (comment)

And just to note, I'm not protective over this extension or it's concept, I just found the implementation in cyrusimap/cyrus-imapd#2029 a while back and turned it into an extension to improve my understanding of Sphinx/Python. So if other (more qualified) people want to run with it, I am totally fine with that, but also happy to help.

-Jared

@theletterf
Copy link

@AA-Turner Bumping this and see if I can be of help. AFAIK, none of the existing extensions can work around the fact that git timestamps are wrong or overwritten when regenerating all files (for example, in Dockerized environments). I've tried git-restore-mtime to solve this, to no avail. So, not sure how one can get Sphinx to render doc timestamps that are faithful to the last modification date of the source.

@jdillard
Copy link
Owner

You can ignore the above, @theletterf was pointed to the cause of his issue: mgeier/sphinx-last-updated-by-git#76

@theletterf
Copy link

Yup.

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

No branches or pull requests

3 participants