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

docs: set html_last_updated_fmt to format string #54

Merged
merged 1 commit into from
Mar 12, 2023

Conversation

paravoid
Copy link
Contributor

According to the Sphinx documentation and source code, html_last_updated_fmt is supposed to be a strftime()-like format string, not a literal string with a date.

Instead of datetime.now().isoformat, set this to the equivalent format string (sans microseconds, as Sphinx does not support %f).

This is a no-op generally. However, unlike our implementation here, Sphinx's date generation obeys SOURCE_DATE_EPOCH, which means that the builds will now be able to be built reproducibly.

Fixes #53

According to the Sphinx documentation and source code,
html_last_updated_fmt is supposed to be a strftime()-like format string,
not a literal string with a date.

Instead of datetime.now().isoformat, set this to the equivalent format
string (sans microseconds, as Sphinx does not support %f).

This is a no-op generally. However, unlike our implementation here,
Sphinx's date generation obeys SOURCE_DATE_EPOCH, which means that the
builds will now be able to be built reproducibly.

Fixes tox-dev#53

Signed-off-by: Faidon Liambotis <paravoid@debian.org>
@gaborbernat gaborbernat merged commit 9fe14ae into tox-dev:main Mar 12, 2023
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.

Sphinx's html_last_updated_fmt should be set to a format string, not literal
2 participants