sqlalchemyorg / zzzeeksphinx

zzzeek's sphinx layout (used by SQLAlchemy, Mako templaets)
Other
4 stars 4 forks source link

Provide reproducible build support for 'last generated' statement #24

Closed jayaddison closed 8 months ago

jayaddison commented 8 months ago

This updates the base theme layout to respect the SOURCE_DATE_EPOCH reproducible build environment variable when it is present, improving support for reproducible documentation builds.

Appearance / text format:

Source-date-epoch timestamp image

Local system timestamp image

Resolves #23.

CaselIT commented 8 months ago

I'm guessing a release to pypi would be appreciated once this is merged, right?

zzzeek commented 8 months ago

is it being consumed from teh release? our own reqs likely point to the github

CaselIT commented 8 months ago

don't know but I think debian would likely prefer to package a tag / release instead of the main branch

jayaddison commented 8 months ago

I'm guessing a release to pypi would be appreciated once this is merged, right?

Probably, yep - I think it's feasible to package an update without them, but in terms of having more easily comprehensible/comparable package versions, yep, that'd be helpful for Debian.

jayaddison commented 8 months ago

(also: thank you for the code review)

jayaddison commented 8 months ago

Ek, I forgot the space before the %Z. One moment..

zzzeek commented 8 months ago

let's try it out

zzzeek commented 8 months ago

ok that's released, 1.5.0 (though SQLAlchemy's own doc reqs point to the github)

jayaddison commented 8 months ago

It's looking good to me so far, thanks again both. An automated reproducibility test of mako with zzzeeksphinx v1.5.0 produces a successful result with this change in place. I'll continue to check on that and sqlalchemy documentation builds over the next few weeks.