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 #2937

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.

Also see tox-dev/pyproject-api#53 for context and tox-dev/pyproject-api#54 for the equivalent PR there.

Thanks for contribution

Please, make sure you address all the checklists (for details on how see
development documentation)!

  • ran the linter to address style issues (tox -e fix)
  • wrote descriptive pull request text
  • ensured there are test(s) validating the fix (not necessary I believe)
  • added news fragment in docs/changelog folder (too trivial to document?)
  • updated/extended the documentation (not needed)

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.

Signed-off-by: Faidon Liambotis <paravoid@debian.org>
@paravoid paravoid requested a review from gaborbernat as a code owner March 10, 2023 19:10
@gaborbernat gaborbernat merged commit 6be22df into tox-dev:main Mar 12, 2023
descope bot referenced this pull request in descope/django-descope Mar 26, 2023
This PR contains the following updates:

| Package | Type | Update | Change | Pending |
|---|---|---|---|---|
| [tox](https://github.com/tox-dev/tox)
([changelog](https://tox.wiki/en/latest/changelog.html)) | dev | patch |
`4.4.6` -> `4.4.7` | `4.4.8` |

---

### Release Notes

<details>
<summary>tox-dev/tox</summary>

### [`v4.4.7`](https://github.com/tox-dev/tox/releases/tag/4.4.7)

[Compare Source](https://github.com/tox-dev/tox/compare/4.4.6...4.4.7)

#### What's Changed

- docs(config): fix temp_dir default value by
[@&#8203;thecesrom](https://github.com/thecesrom) in
[https://github.com/tox-dev/tox/pull/2932](https://github.com/tox-dev/tox/pull/2932)
- docs: set html_last_updated_fmt to format string by
[@&#8203;paravoid](https://github.com/paravoid) in
[https://github.com/tox-dev/tox/pull/2937](https://github.com/tox-dev/tox/pull/2937)

#### New Contributors

- [@&#8203;thecesrom](https://github.com/thecesrom) made their first
contribution in
[https://github.com/tox-dev/tox/pull/2932](https://github.com/tox-dev/tox/pull/2932)

**Full Changelog**: tox-dev/tox@4.4.6...4.4.7

</details>

---

### Configuration

📅 **Schedule**: Branch creation - At any time (no schedule defined),
Automerge - At any time (no schedule defined).

🚦 **Automerge**: Enabled.

♻ **Rebasing**: Whenever PR is behind base branch, or you tick the
rebase/retry checkbox.

🔕 **Ignore**: Close this PR and you won't be reminded about this update
again.

---

- [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check
this box

<!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNC4xMDEuMCIsInVwZGF0ZWRJblZlciI6IjM0LjEwMS4wIn0=-->

Co-authored-by: descope[bot] <descope[bot]@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants