◐ Shell
reader mode source ↗
Skip to content

bpo-45618: Fix documentation build by pinning Docutils version#29230

Merged
ned-deily merged 2 commits into
python:mainfrom
m-aciek:docs-pin-docutils
Oct 27, 2021
Merged

bpo-45618: Fix documentation build by pinning Docutils version#29230
ned-deily merged 2 commits into
python:mainfrom
m-aciek:docs-pin-docutils

Conversation

@m-aciek

@m-aciek m-aciek commented Oct 26, 2021 •
edited by bedevere-bot
Loading

Copy link
Copy Markdown
Contributor

Since the release of Docutils 0.18 today building Python documentation fails.

In CPython repository we have Sphinx pinned to 3.2.1, which has too loose requirement for Docutils version in install_requires – docutils>=0.12.

Example of failing build: https://github.com/python/python-docs-pl/runs/4009459257.

The pin can be removed after bumping Sphinx to at least 3.5.4, which introduced upper limit for docutils version.

sphinx-doc/sphinx@9263eea

https://bugs.python.org/issue45618

@erlend-aasland

erlend-aasland commented Oct 27, 2021

Copy link
Copy Markdown
Contributor

cc. @pablogsal

@erlend-aasland erlend-aasland mentioned this pull request Oct 27, 2021
Merged
@ned-deily
Update Doc/requirements.txt …
4f44737 
Co-authored-by: Erlend Egeberg Aasland <erlend.aasland@innova.no>
ned-deily
ned-deily approved these changes Oct 27, 2021
View reviewed changes

@ned-deily ned-deily 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.

Hide comment

This should be OK as at least a temporary measure. I would like @JulienPalard as the documentation release expert to review the situation for a permanent solution. Other things will need to be updated one way or another.

@ned-deily ned-deily merged commit bcee6aa into python:main Oct 27, 2021
@miss-islington

miss-islington commented Oct 27, 2021

Copy link
Copy Markdown
Contributor

Thanks @m-aciek for the PR, and @ned-deily for merging it 🌮🎉.. I'm working now to backport this PR to: 3.9, 3.10.
🐍🍒⛏🤖

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Oct 27, 2021
@m-aciek @miss-islington
bpo-45618: Fix documentation build by pinning Docutils version to 0.1… …
fe779a8 
…7.1 (pythonGH-29230)

Co-authored-by: Maciej Olko <maciej.olko@yougov.com>
Co-authored-by: Erlend Egeberg Aasland <erlend.aasland@innova.no>
(cherry picked from commit bcee6aa)

Co-authored-by: m-aciek <m-aciek@users.noreply.github.com>
@miss-islington

miss-islington commented Oct 27, 2021

Copy link
Copy Markdown
Contributor

Sorry, @m-aciek and @ned-deily, I could not cleanly backport this to 3.9 due to a conflict.
Please backport using cherry_picker on command line.
cherry_picker bcee6aa31550cfecdc3acecbd0e4447bb0051887 3.9

@bedevere-bot bedevere-bot removed the needs backport to 3.10 only security fixes label Oct 27, 2021
@bedevere-bot

bedevere-bot commented Oct 27, 2021

Copy link
Copy Markdown

GH-29240 is a backport of this pull request to the 3.10 branch.

ned-deily pushed a commit to ned-deily/cpython that referenced this pull request Oct 27, 2021
@m-aciek @ned-deily
bpo-45618: Fix documentation build by pinning Docutils version to 0.1… …
56c9825 
…7.1 (pythonGH-29230)

Co-authored-by: Maciej Olko <maciej.olko@yougov.com>
Co-authored-by: Erlend Egeberg Aasland <erlend.aasland@innova.no>
@bedevere-bot

bedevere-bot commented Oct 27, 2021

Copy link
Copy Markdown

GH-29241 is a backport of this pull request to the 3.9 branch.

ned-deily pushed a commit that referenced this pull request Oct 27, 2021
@miss-islington
bpo-45618: Fix documentation build by pinning Docutils version to 0.1… …
2b7b7c7 
…7.1 (GH-29230) (GH-29240)

Co-authored-by: Maciej Olko <maciej.olko@yougov.com>
Co-authored-by: Erlend Egeberg Aasland <erlend.aasland@innova.no>
(cherry picked from commit bcee6aa)
@JulienPalard

JulienPalard commented Oct 27, 2021

Copy link
Copy Markdown
Member

Thanks @m-aciek and @ned-deily for acting fast on this! The docutils release also broke pospell we use python-docs-fr side, I should have suspected it would broke Sphinx too, but I did not.

ned-deily added a commit that referenced this pull request Oct 27, 2021
@ned-deily
[3.9] bpo-45618: Fix documentation build by pinning Docutils version … …
30c1f18 
…to 0.17.1 (GH-29230) (GH-29241)

Co-authored-by: Maciej Olko <maciej.olko@yougov.com>
Co-authored-by: Erlend Egeberg Aasland <erlend.aasland@innova.no>
@erlend-aasland

erlend-aasland commented Oct 27, 2021

Copy link
Copy Markdown
Contributor

3.8 is not EOL yet, so I guess we have to backport to 3.8 as well, @ambv?

ned-deily added a commit to ned-deily/cpython that referenced this pull request Oct 27, 2021
@ned-deily
[3.9] bpo-45618: Fix documentation build by pinning Docutils version … …
633b708 
…to 0.17.1 (pythonGH-29230) (pythonGH-29241)

Co-authored-by: Maciej Olko <maciej.olko@yougov.com>
Co-authored-by: Erlend Egeberg Aasland <erlend.aasland@innova.no>
@ned-deily

ned-deily commented Oct 27, 2021

Copy link
Copy Markdown
Member

Yes, thanks, I've just submitted a 3.8 PR. Also, 3.7 and 3.6 are affected as well, since we build documentation for security-fix branches. But the backport is a little more complicated for them because the changes that introduced the use of requirements.txt in the Doc Makefile were never backported to them. I should have done that before, we should do it now. If anyone gets to it first, yay.

@m-aciek m-aciek deleted the docs-pin-docutils branch October 27, 2021 20:16
ambv pushed a commit that referenced this pull request Oct 28, 2021
@ned-deily
[3.9] bpo-45618: Fix documentation build by pinning Docutils version … …
f240714 
…to 0.17.1 (GH-29230) (GH-29241) (GH-29245)

Co-authored-by: Maciej Olko <maciej.olko@yougov.com>
Co-authored-by: Erlend Egeberg Aasland <erlend.aasland@innova.no>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@erlend-aasland erlend-aasland erlend-aasland approved these changes

@ned-deily ned-deily ned-deily approved these changes

@pablogsal pablogsal Awaiting requested review from pablogsal

@JulienPalard JulienPalard Awaiting requested review from JulienPalard

Assignees

@ned-deily ned-deily

Labels

skip news

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

7 participants

@m-aciek @erlend-aasland @miss-islington @bedevere-bot @JulienPalard @ned-deily @the-knights-who-say-ni