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

Jump to bottom

Make the documentation build reproducibly #25

Merged
merged 1 commit into from Feb 16, 2022
Merged

Make the documentation build reproducibly #25

merged 1 commit into from Feb 16, 2022

Conversation

lamby
Copy link
Contributor

@lamby lamby commented Feb 15, 2022 

Whilst working on the Reproducible Builds effort [0], I noticed that
mpl-sphinx-theme could not be built reproducibly.

This is because the documentation embedded the current build year. This PR
changes the behaviour of the Sphinx documentation so that it can that
optionally use SOURCE_DATE_EPOCH [1] as the source of this value instead.

I originally filed this in Debian as bug #1005826 [2].

 [0] https://reproducible-builds.org/
 [1] https://reproducible-builds.org/specs/source-date-epoch/
 [2] https://bugs.debian.org/1005826

@QuLogic
Copy link
Member

QuLogic commented Feb 15, 2022

Please add a comment, as in Matplotlib: https://github.com/matplotlib/matplotlib/blob/main/doc/conf.py#L33

@lamby
Make the documentation build reproducibly
5467339 
Whilst working on the Reproducible Builds effort [0], I noticed that
mpl-sphinx-theme could not be built reproducibly.

This is because the documentation embedded the current build year. This patch
changes the behaviour of the Sphinx documentation so that it can that
optionally use SOURCE_DATE_EPOCH [1] as the source of this value instead.

I originally filed this in Debian as bug #1005826 [2].

 [0] https://reproducible-builds.org/
 [1] https://reproducible-builds.org/specs/source-date-epoch/
 [2] https://bugs.debian.org/1005826
@lamby lamby force-pushed the 1005826-mpl-sphinx-theme-please-make-the-build-reproducible branch from 6740ef3 to 5467339 Compare February 15, 2022 21:49
@lamby
Copy link
Contributor Author

lamby commented Feb 15, 2022

No problem. Force-pushed an update. 👍

@QuLogic QuLogic merged commit e9c6463 into matplotlib:main Feb 16, 2022
2 of 3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@QuLogic QuLogic QuLogic approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
2 participants
@lamby @QuLogic