Skip to content

Hosted documentation has not been updated in over a week #122868

New issue
New issue
Closed
#122870
Closed
Hosted documentation has not been updated in over a week#122868
#122870
Labels
3.12only security fixesdocsDocumentation in the Doc dir

Description

@aphedges
aphedges
opened on Aug 9, 2024

Documentation

I tried viewing the Changelog to see what was included in the Python 3.12.5 release, and I noticed the page states "Last updated on Jul 31, 2024 (11:04 UTC)". I checked several other pages on the 3.12 documentation site, and they all have the same date. I checked the 3.13 and 3.14 docs, and both of them were built earlier today. The older documentation should be rebuilt whenever there is a release so the changelog can be read.

Linked PRs

Activity

  1. aphedges
    added
    docsDocumentation in the Doc dir
    on Aug 9, 2024

  2. hugovk commented on Aug 9, 2024

    @hugovk
    hugovk
    on Aug 9, 2024
    Member

    Thanks for the report. They should be built roughly every 24 hours.

    I see the 3.13 docs were updated an hour ago, and 3.14 docs some 14 hours ago, so looks like this is just affecting 3.12.

    @JulienPalard Please could you check the 3.12 docs build on the server?

  3. hugovk commented on Aug 9, 2024

    @hugovk
    hugovk
    on Aug 9, 2024
    Member

    I also have access to the docs server, and this is in /var/log/docsbuild/docsbuild.log:

    2024-08-09 12:08:45,929 INFO en/3.12: Running.
2024-08-09 12:08:45,929 DEBUG en/3.12: Run: 'git -C /srv/docsbuild/cpython show-ref -s origin/3.12'
2024-08-09 12:08:45,932 DEBUG en/3.12: Run: 'git -C /srv/docsbuild/cpython reset --hard c536f59c62eca95f0f4ef3fd688f5c387dd40ae6 --'
2024-08-09 12:08:45,956 DEBUG en/3.12: https://sentry.io:443 "POST /api/1307574/store/ HTTP/1.1" 200 41
2024-08-09 12:08:45,957 DEBUG en/3.12: Run: 'git -C /srv/docsbuild/cpython clean -dfqx'
2024-08-09 12:08:45,996 DEBUG en/3.12: https://sentry.io:443 "POST /api/1307574/store/ HTTP/1.1" 200 41
2024-08-09 12:08:46,079 DEBUG en/3.12: Run: 'git -C /srv/docsbuild/cpython rev-parse HEAD'
2024-08-09 12:08:46,082 DEBUG en/3.12: Run: 'git -C /srv/docsbuild/cpython diff --name-only efba83f9864eaac63ec0937c2f256f2a8c16191e c536f59c62eca95f0f4ef3fd688f5c387dd40ae6'
2024-08-09 12:08:46,132 INFO en/3.12: Should rebuild: Doc/ has changed (from efba83f9864eaac63ec0937c2f256f2a8c16191e to c536f59c62eca95f0f4ef3fd688f5c387dd40ae6)
2024-08-09 12:08:46,132 DEBUG en/3.12: Run: '/srv/docsbuild/venv/bin/python -m venv /srv/docsbuild/venv-3.12'
2024-08-09 12:08:48,531 DEBUG en/3.12: Run: '/srv/docsbuild/venv-3.12/bin/python -m pip install --upgrade python-docs-theme jieba -rrequirements.txt'
2024-08-09 12:08:49,715 DEBUG en/3.12: Run: '/srv/docsbuild/venv-3.12/bin/python -m pip freeze --all'
2024-08-09 12:08:50,198 INFO en/3.12: Build start.
2024-08-09 12:08:50,198 INFO en/3.12: Running make autobuild-stable
2024-08-09 12:08:50,198 DEBUG en/3.12: Run: "sed -i 's/ *-A switchers=1//' /srv/docsbuild/cpython/Doc/Makefile"
2024-08-09 12:08:50,204 DEBUG en/3.12: Run: "make -C /srv/docsbuild/cpython/Doc PYTHON=/srv/docsbuild/venv-3.12/bin/python SPHINXBUILD=/srv/docsbuild/venv-3.12/bin/sphinx-build BLURB=/srv/docsbuild/venv-3.12/bin/blurb VENVDIR=/srv/docsbuild/venv-3.12 'SPHINXOPTS=-D latex_engine=xelatex -D latex_elements.inputenc= -D latex_elements.fontenc= -q' SPHINXERRORHANDLING= autobuild-stable"
2024-08-09 12:08:54,260 ERROR en/3.12: Run: "make -C /srv/docsbuild/cpython/Doc PYTHON=/srv/docsbuild/venv-3.12/bin/python SPHINXBUILD=/srv/docsbuild/venv-3.12/bin/sphinx-build BLURB=/srv/docsbuild/venv-3.12/bin/blurb VENVDIR=/srv/docsbuild/venv-3.12 'SPHINXOPTS=-D latex_engine=xelatex -D latex_elements.inputenc= -D latex_elements.fontenc= -q' SPHINXERRORHANDLING= autobuild-stable" KO:
    mkdir -p dist
    # archive the HTML
    make html
    make[3]: Entering directory '/srv/docsbuild/cpython/Doc'
    mkdir -p build
    Building NEWS from Misc/NEWS.d with blurb
    /srv/docsbuild/venv-3.12/bin/sphinx-build -b html -d build/doctrees -j auto  -D latex_engine=xelatex -D latex_elements.inputenc= -D latex_elements.fontenc= -q -Ea -A daily=1  . build/html

    Extension error:
    Could not import extension sphinxcontrib.applehelp (exception: cannot import name 'SkipProgressMessage' from 'sphinx.util' (/srv/docsbuild/venv-3.12/lib/python3.10/site-packages/sphinx/util/__init__.py))
    matplotlib is not installed, social cards will not be generated
    make[3]: *** [Makefile:56: build] Error 2
    make[3]: Leaving directory '/srv/docsbuild/cpython/Doc'
    make[2]: *** [Makefile:190: dist] Error 2
    make[2]: Leaving directory '/srv/docsbuild/cpython/Doc'
    make[1]: *** [Makefile:274: autobuild-dev] Error 2
    make[1]: Leaving directory '/srv/docsbuild/cpython/Doc'
    make: *** [Makefile:286: autobuild-stable] Error 2
    make: Leaving directory '/srv/docsbuild/cpython/Doc'

2024-08-09 12:08:54,264 ERROR en/3.12: Badly handled exception, human, please help.
Traceback (most recent call last):
  File "/srv/docsbuild/scripts/build_docs.py", line 655, in run
    self.build()
  File "/srv/docsbuild/scripts/build_docs.py", line 762, in build
    run(
  File "/srv/docsbuild/scripts/build_docs.py", line 247, in run
    result.check_returncode()
  File "/usr/lib/python3.10/subprocess.py", line 457, in check_returncode
    raise CalledProcessError(self.returncode, self.args, self.stdout,
subprocess.CalledProcessError: Command '['make', '-C', '/srv/docsbuild/cpython/Doc', 'PYTHON=/srv/docsbuild/venv-3.12/bin/python', 'SPHINXBUILD=/srv/docsbuild/venv-3.12/bin/sphinx-build', 'BLURB=/srv/docsbuild/venv-3.12/bin/blurb', 'VENVDIR=/srv/docsbuild/venv-3.12', 'SPHINXOPTS=-D latex_engine=xelatex -D latex_elements.inputenc= -D latex_elements.fontenc= -q', 'SPHINXERRORHANDLING=', 'autobuild-stable']' returned non-zero exit status 2.

    That error again:

    Could not import extension sphinxcontrib.applehelp (exception: cannot import name 'SkipProgressMessage' from 'sphinx.util' (/srv/docsbuild/venv-3.12/lib/python3.10/site-packages/sphinx/util/__init__.py))

    Sounds like it's related to #122500, merged on 31st July, which is around the time of the last build.

    I can build the 3.12 docs locally, but that's with a clean venv and I think the docs server persists existing venvs.

    The server has these Sphinx things in the venv:

    $ ls /srv/docsbuild/venv-3.12/lib/python3.10/site-packages/ | grep "sphinx.*dist.info"
sphinx-8.0.2.dist-info
sphinx_autobuild-2024.4.16.dist-info
sphinx_lint-0.6.7.dist-info
sphinx_notfound_page-1.0.4.dist-info
sphinxcontrib_applehelp-1.0.2.dist-info
sphinxcontrib_devhelp-1.0.2.dist-info
sphinxcontrib_htmlhelp-2.0.0.dist-info
sphinxcontrib_jsmath-1.0.1.dist-info
sphinxcontrib_qthelp-1.0.3.dist-info
sphinxcontrib_serializinghtml-1.1.9.dist-info
sphinxext_opengraph-0.9.1.dist-info

    However, locally, I have v2 of many of those including sphinxcontrib-applehelp:

     + sphinx==8.0.2
 + sphinx-notfound-page==1.0.4
 + sphinxcontrib-applehelp==2.0.0
 + sphinxcontrib-devhelp==2.0.0
 + sphinxcontrib-htmlhelp==2.1.0
 + sphinxcontrib-jsmath==1.0.1
 + sphinxcontrib-qthelp==2.0.0
 + sphinxcontrib-serializinghtml==2.0.0
 + sphinxext-opengraph==0.9.1

    @AA-Turner Do you think we need to supply a minimum version for sphinxcontrib.applehelp? Or should Sphinx specify it?

    It might make sense to update https://github.com/python/docsbuild-scripts to clear the venv each time as well. This problem didn't show up on our GitHub Actions or Read the Docs builds, because they start with a clean slate each time.

  4. hugovk
    added
    3.12only security fixes
    on Aug 9, 2024

  5. ned-deily commented on Aug 9, 2024

    @ned-deily
    ned-deily
    on Aug 9, 2024
    Member

    We don't build any applehelp books, AFAIK. Can we just not require it?

  6. AA-Turner commented on Aug 9, 2024

    @AA-Turner
    AA-Turner
    on Aug 9, 2024
    Member

    Do you think we need to supply a minimum version for sphinxcontrib.applehelp? Or should Sphinx specify it?

    sphinxcontrib-applehelp 1.0.3 fixes this issue. I'll add lower-bounds in Sphinx, but that will only fix things going forwards. I remember another dependency issue here though, I thought we fixed it by making pip install and update?

    We don't build any applehelp books, AFAIK. Can we just not require it?

    It's a core sphinx plugin, we can't remove it (sphinx has odd packaging due to history)

    A

  7. zware commented on Aug 9, 2024

    @zware
    zware
    on Aug 9, 2024
    Member

    Suggestion: add --upgrade-strategy=eager to https://github.com/python/docsbuild-scripts/blob/213530446b083788da9dbf4ca02284b5dc9c5c5c/build_docs.py#L792

  8. hugovk
    added a commit that references this issue on Aug 9, 2024

    gh-122868: Add lower bounds for sphinxcontrib dependencies (#122870)

    0fd97e4
  9. hugovk
    closed this as completedin #122870on Aug 9, 2024
  10. miss-islington
    added 2 commits that reference this issue on Aug 9, 2024

    pythongh-122868: Add lower bounds for sphinxcontrib dependencies (pyt…

    b519c35

    pythongh-122868: Add lower bounds for sphinxcontrib dependencies (pyt…

    3a5a4f0

  11. hugovk commented on Aug 9, 2024

    @hugovk
    hugovk
    on Aug 9, 2024
    Member

    Re-opening, #122870 only partially resolves this.

  12. hugovk
    reopened this on Aug 9, 2024
  13. hugovk
    added 2 commits that reference this issue on Aug 9, 2024

    [3.12] gh-122868: Add lower bounds for sphinxcontrib dependencies (GH…

    d944484

    [3.13] gh-122868: Add lower bounds for sphinxcontrib dependencies (GH…

    f28c399

  14. hugovk commented on Aug 10, 2024

    @hugovk
    hugovk
    on Aug 10, 2024
    Member

    Next error:

    Could not import extension sphinxcontrib.htmlhelp (exception: cannot import name 'progress_message' from 'sphinx.util' (/srv/docsbuild/venv-3.12/lib/python3.10/site-packages/sphinx/util/__init__.py))

    Full log:

    2024-08-10 18:08:47,323 INFO en/3.12: Running.
2024-08-10 18:08:47,323 DEBUG en/3.12: Run: 'git -C /srv/docsbuild/cpython show-ref -s origin/3.12'
2024-08-10 18:08:47,327 DEBUG en/3.12: Run: 'git -C /srv/docsbuild/cpython reset --hard d9444844d7f322334c001c1a301c560d88c78e76 --'
2024-08-10 18:08:47,351 DEBUG en/3.12: https://sentry.io:443 "POST /api/1307574/store/ HTTP/1.1" 200 41
2024-08-10 18:08:47,355 DEBUG en/3.12: Run: 'git -C /srv/docsbuild/cpython clean -dfqx'
2024-08-10 18:08:47,393 DEBUG en/3.12: https://sentry.io:443 "POST /api/1307574/store/ HTTP/1.1" 200 41
2024-08-10 18:08:47,562 DEBUG en/3.12: Run: 'git -C /srv/docsbuild/cpython rev-parse HEAD'
2024-08-10 18:08:47,566 DEBUG en/3.12: Run: 'git -C /srv/docsbuild/cpython diff --name-only efba83f9864eaac63ec0937c2f256f2a8c16191e d9444844d7f322334c001c1a301c560d88c78e76'
2024-08-10 18:08:47,622 INFO en/3.12: Should rebuild: Doc/ has changed (from efba83f9864eaac63ec0937c2f256f2a8c16191e to d9444844d7f322334c001c1a301c560d88c78e76)
2024-08-10 18:08:47,623 DEBUG en/3.12: Run: '/srv/docsbuild/venv/bin/python -m venv /srv/docsbuild/venv-3.12'
2024-08-10 18:08:50,077 DEBUG en/3.12: Run: '/srv/docsbuild/venv-3.12/bin/python -m pip install --upgrade python-docs-theme jieba -rrequirements.txt'
2024-08-10 18:08:51,166 DEBUG en/3.12: Run: '/srv/docsbuild/venv-3.12/bin/python -m pip freeze --all'
2024-08-10 18:08:51,694 INFO en/3.12: Build start.
2024-08-10 18:08:51,694 INFO en/3.12: Running make autobuild-stable
2024-08-10 18:08:51,694 DEBUG en/3.12: Run: "sed -i 's/ *-A switchers=1//' /srv/docsbuild/cpython/Doc/Makefile"
2024-08-10 18:08:51,700 DEBUG en/3.12: Run: "make -C /srv/docsbuild/cpython/Doc PYTHON=/srv/docsbuild/venv-3.12/bin/python SPHINXBUILD=/srv/docsbuild/venv-3.12/bin/sphinx-build BLURB=/srv/docsbuild/venv-3.12/bin/blurb VENVDIR=/srv/docsbuild/venv-3.12 'SPHINXOPTS=-D latex_engine=xelatex -D latex_elements.inputenc= -D latex_elements.fontenc= -q' SPHINXERRORHANDLING= autobuild-stable"
2024-08-10 18:08:55,246 ERROR en/3.12: Run: "make -C /srv/docsbuild/cpython/Doc PYTHON=/srv/docsbuild/venv-3.12/bin/python SPHINXBUILD=/srv/docsbuild/venv-3.12/bin/sphinx-build BLURB=/srv/docsbuild/venv-3.12/bin/blurb VENVDIR=/srv/docsbuild/venv-3.12 'SPHINXOPTS=-D latex_engine=xelatex -D latex_elements.inputenc= -D latex_elements.fontenc= -q' SPHINXERRORHANDLING= autobuild-stable" KO:
    mkdir -p dist
    # archive the HTML
    make html
    make[3]: Entering directory '/srv/docsbuild/cpython/Doc'
    mkdir -p build
    Building NEWS from Misc/NEWS.d with blurb
    /srv/docsbuild/venv-3.12/bin/sphinx-build -b html -d build/doctrees -j auto  -D latex_engine=xelatex -D latex_elements.inputenc= -D latex_elements.fontenc= -q -Ea -A daily=1  . build/html

    Extension error:
    Could not import extension sphinxcontrib.htmlhelp (exception: cannot import name 'progress_message' from 'sphinx.util' (/srv/docsbuild/venv-3.12/lib/python3.10/site-packages/sphinx/util/__init__.py))
    matplotlib is not installed, social cards will not be generated
    make[3]: *** [Makefile:56: build] Error 2
    make[3]: Leaving directory '/srv/docsbuild/cpython/Doc'
    make[2]: *** [Makefile:190: dist] Error 2
    make[2]: Leaving directory '/srv/docsbuild/cpython/Doc'
    make[1]: *** [Makefile:274: autobuild-dev] Error 2
    make[1]: Leaving directory '/srv/docsbuild/cpython/Doc'
    make: *** [Makefile:286: autobuild-stable] Error 2
    make: Leaving directory '/srv/docsbuild/cpython/Doc'

2024-08-10 18:08:55,250 ERROR en/3.12: Badly handled exception, human, please help.
Traceback (most recent call last):
  File "/srv/docsbuild/scripts/build_docs.py", line 655, in run
    self.build()
  File "/srv/docsbuild/scripts/build_docs.py", line 762, in build
    run(
  File "/srv/docsbuild/scripts/build_docs.py", line 247, in run
    result.check_returncode()
  File "/usr/lib/python3.10/subprocess.py", line 457, in check_returncode
    raise CalledProcessError(self.returncode, self.args, self.stdout,
subprocess.CalledProcessError: Command '['make', '-C', '/srv/docsbuild/cpython/Doc', 'PYTHON=/srv/docsbuild/venv-3.12/bin/python', 'SPHINXBUILD=/srv/docsbuild/venv-3.12/bin/sphinx-build', 'BLURB=/srv/docsbuild/venv-3.12/bin/blurb', 'VENVDIR=/srv/docsbuild/venv-3.12', 'SPHINXOPTS=-D latex_engine=xelatex -D latex_elements.inputenc= -D latex_elements.fontenc= -q', 'SPHINXERRORHANDLING=', 'autobuild-stable']' returned non-zero exit status 2.

    The server now has:

    $ ls /srv/docsbuild/venv-3.12/lib/python3.10/site-packages/ | grep "sphinx.*dist.info"
sphinx-8.0.2.dist-info
sphinx_autobuild-2024.4.16.dist-info
sphinx_lint-0.6.7.dist-info
sphinx_notfound_page-1.0.4.dist-info
sphinxcontrib_applehelp-2.0.0.dist-info
sphinxcontrib_devhelp-2.0.0.dist-info
sphinxcontrib_htmlhelp-2.0.0.dist-info
sphinxcontrib_jsmath-1.0.1.dist-info
sphinxcontrib_qthelp-2.0.0.dist-info
sphinxcontrib_serializinghtml-1.1.9.dist-info
sphinxext_opengraph-0.9.1.dist-info

    sphinxcontrib_htmlhelp-2.0.0 same as before.

    Locally I have sphinxcontrib-htmlhelp==2.1.0:

     + sphinx==8.0.2
 + sphinx-notfound-page==1.0.4
 + sphinxcontrib-applehelp==2.0.0
 + sphinxcontrib-devhelp==2.0.0
 + sphinxcontrib-htmlhelp==2.1.0
 + sphinxcontrib-jsmath==1.0.1
 + sphinxcontrib-qthelp==2.0.0
 + sphinxcontrib-serializinghtml==2.0.0
 + sphinxext-opengraph==0.9.1

    Do we need to require sphinxcontrib-htmlhelp>=2.1?

    Edit: and sphinxcontrib_serializinghtml are different, do we need something there?

    Should Sphinx require the minimum versions of its dependencies in pyproject.toml, so users of Sphinx don't have to figure out through trial-and-error which are the minimum versions Sphinx needs? For example, at least sphinxcontrib-applehelp has no min version at:

    https://github.com/sphinx-doc/sphinx/blob/e3238260f6e2fddfb71a38acd44511307c5c5d2f/pyproject.toml#L57-L75

  15. AA-Turner commented on Aug 10, 2024

    @AA-Turner
    AA-Turner
    on Aug 10, 2024
    Member

    See https://github.com/sphinx-doc/sphinx/pull/12756/files which adds lower bounds and additionally validates the lower bounds through a new CI job. Then see #122891 to copy over those (now-tested) lower bounds verbatim.

    A

  16. AA-Turner
    added a commit that references this issue on Aug 10, 2024

    gh-122868: Add more lower bounds for sphinxcontrib dependencies (#122891

    0959142
  17. miss-islington
    added 2 commits that reference this issue on Aug 10, 2024

    pythongh-122868: Add more lower bounds for sphinxcontrib dependencies (…

    78e9a3f

    pythongh-122868: Add more lower bounds for sphinxcontrib dependencies (…

    3685735
  18. AA-Turner
    added 2 commits that reference this issue on Aug 10, 2024

    [3.12] gh-122868: Add more lower bounds for sphinxcontrib dependencies (

    d70c399

    [3.13] gh-122868: Add more lower bounds for sphinxcontrib dependencies (

    b62f8c9

  19. hugovk commented on Aug 11, 2024

    @hugovk
    hugovk
    on Aug 11, 2024
    Member

    Thanks all, https://docs.python.org/3/ has just been updated!

    Logs:

    2024-08-11 07:56:59,356 INFO en/3.12: Running.
...
2024-08-11 07:57:04,184 INFO en/3.12: Build start.
...
2024-08-11 08:33:42,238 INFO en/3.12: Build done.
2024-08-11 08:33:42,238 INFO en/3.12: Publishing start.
...
2024-08-11 08:35:00,608 INFO en/3.12: Publishing done

    Website:

    Last updated on Aug 11, 2024 (07:57 UTC).

    Do we want to keep this issue open pending python/docsbuild-scripts#180 or is it okay to close?

  20. AA-Turner commented on Aug 11, 2024

    @AA-Turner
    AA-Turner
    on Aug 11, 2024
    Member

    Let's close this, the main task at hand is done. Sorry for causing the trouble!

    A

  21. AA-Turner
    closed this as completedon Aug 11, 2024

  22. aphedges commented on Aug 11, 2024

    @aphedges
    aphedges
    on Aug 11, 2024
    ContributorAuthor

    I can confirm that the changelog has been updated. Thank you very much for fixing this!

  23. blhsing
    added 2 commits that reference this issue on Aug 22, 2024

    pythongh-122868: Add lower bounds for sphinxcontrib dependencies (pyt…

    1eb748e

    pythongh-122868: Add more lower bounds for sphinxcontrib dependencies (…

    0fce01a
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    3.12only security fixesdocsDocumentation in the Doc dir

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions