Skip to content

Docs: Add the time to the HTML last updated format - #110091

Merged
vstinner merged 7 commits into
python:mainfrom
AA-Turner:docs/last-updated-time
Nov 15, 2023
Merged

Docs: Add the time to the HTML last updated format#110091
vstinner merged 7 commits into
python:mainfrom
AA-Turner:docs/last-updated-time

Conversation

@AA-Turner

@AA-Turner AA-Turner commented Sep 29, 2023 •
edited by github-actions Bot
Loading

Copy link
Copy Markdown
Member

@AA-Turner AA-Turner added docs Documentation in the Doc dir skip issue skip news needs backport to 3.11 only security fixes needs backport to 3.12 only security fixes labels Sep 29, 2023
@AA-Turner
AA-Turner requested a review from hugovk September 29, 2023 10:29
@AA-Turner AA-Turner mentioned this pull request Sep 29, 2023
Closed
vstinner
vstinner approved these changes Sep 29, 2023
View reviewed changes

@vstinner vstinner left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM. Thank you for today that.

... Do you have access to the timezone?

@vstinner

vstinner commented Sep 29, 2023

Copy link
Copy Markdown
Member

If you have no timezone information, can we use UTC timestamp?

@vstinner

vstinner commented Sep 29, 2023

Copy link
Copy Markdown
Member

Is it UTC?

https://github.com/sphinx-doc/sphinx/blob/b9c85984d2f4863e4c09932c746d915e3233507b/sphinx/util/i18n.py#L192-L199

vstinner
vstinner reviewed Sep 29, 2023
View reviewed changes
Comment thread Doc/conf.py Outdated
@AA-Turner @vstinner
Add the timezone
8559481 
Co-authored-by: Victor Stinner <vstinner@python.org>
vstinner
vstinner approved these changes Sep 29, 2023
View reviewed changes

@vstinner vstinner left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, even better with the timezone :-)

@hugovk

hugovk commented Sep 29, 2023

Copy link
Copy Markdown
Member

👍

image

hugovk
hugovk requested changes Sep 29, 2023
View reviewed changes
Comment thread Doc/conf.py Outdated
vstinner
vstinner reviewed Sep 29, 2023
View reviewed changes
Comment thread Doc/conf.py Outdated
hugovk
hugovk reviewed Sep 30, 2023
View reviewed changes
Comment thread Doc/conf.py Outdated
@AA-Turner

AA-Turner commented Oct 18, 2023

Copy link
Copy Markdown
Member Author

Now:

image

A

@AA-Turner
AA-Turner requested a review from hugovk October 18, 2023 09:42
hugovk
hugovk approved these changes Oct 18, 2023
View reviewed changes

@hugovk hugovk left a comment •
edited
Loading

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good:

image

Non-blocking:

I'd still prefer "UTC" instead of "GMT", strictly speaking they're not the same: GMT is a timezone used by some countries, UTC is the standard. And UTC is maybe better known, judging by Google results (GMT: "About 527 000 000 results", UTC: "About 2 550 000 000 results").

vstinner
vstinner approved these changes Oct 18, 2023
View reviewed changes

@vstinner vstinner left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM.

@vstinner

vstinner commented Oct 18, 2023

Copy link
Copy Markdown
Member

Ah right, UTC is better. time.gmtime() is documented to return time in UTC timezone: https://docs.python.org/dev/library/time.html#time.gmtime

vstinner
vstinner reviewed Nov 15, 2023
View reviewed changes
Comment thread Doc/conf.py Outdated
@vstinner
vstinner enabled auto-merge (squash) November 15, 2023 03:56
@vstinner
vstinner merged commit 6c214de into python:main Nov 15, 2023
@miss-islington-app

miss-islington-app Bot commented Nov 15, 2023

Copy link
Copy Markdown

Thanks @AA-Turner for the PR, and @vstinner for merging it 🌮🎉.. I'm working now to backport this PR to: 3.11, 3.12.
🐍🍒⛏🤖

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Nov 15, 2023
@AA-Turner @miss-islington
Docs: Add the time to the HTML last updated format (pythonGH-110091)
58589b8 
(cherry picked from commit 6c214de)

Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
@bedevere-app

bedevere-app Bot commented Nov 15, 2023

Copy link
Copy Markdown

GH-112102 is a backport of this pull request to the 3.12 branch.

@bedevere-app bedevere-app Bot removed the needs backport to 3.12 only security fixes label Nov 15, 2023
miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Nov 15, 2023
@AA-Turner @miss-islington
Docs: Add the time to the HTML last updated format (pythonGH-110091)
5a65d25 
(cherry picked from commit 6c214de)

Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
@bedevere-app

bedevere-app Bot commented Nov 15, 2023

Copy link
Copy Markdown

GH-112103 is a backport of this pull request to the 3.11 branch.

@bedevere-app bedevere-app Bot removed the needs backport to 3.11 only security fixes label Nov 15, 2023
vstinner pushed a commit that referenced this pull request Nov 15, 2023
@miss-islington @AA-Turner
[3.12] Docs: Add the time to the HTML last updated format (GH-110091) (…
c190552 
…#112102)

Docs: Add the time to the HTML last updated format (GH-110091)
(cherry picked from commit 6c214de)

Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
vstinner pushed a commit that referenced this pull request Nov 15, 2023
@miss-islington @AA-Turner
[3.11] Docs: Add the time to the HTML last updated format (GH-110091) (…
a92b9e5 
…#112103)

Docs: Add the time to the HTML last updated format (GH-110091)
(cherry picked from commit 6c214de)

Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
@vstinner

vstinner commented Nov 15, 2023

Copy link
Copy Markdown
Member

I need this feature. I never understand if https://docs.python.org/dev/ was updated or not. So I merged the PR.

Thanks @AA-Turner for this nice enhancement!

aisk pushed a commit to aisk/cpython that referenced this pull request Feb 11, 2024
@AA-Turner @aisk
Docs: Add the time to the HTML last updated format (python#110091)
4d2f252
Glyphack pushed a commit to Glyphack/cpython that referenced this pull request Sep 2, 2024
@AA-Turner @Glyphack
Docs: Add the time to the HTML last updated format (python#110091)
90fc443
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@vstinner vstinner vstinner approved these changes
@hugovk hugovk hugovk approved these changes

Assignees

No one assigned

Labels

docs Documentation in the Doc dir skip issue skip news

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@AA-Turner @vstinner @hugovk