[Python-checkins] [3.9] bpo-45618: Fix documentation build by pinning Docutils version to 0.17.1 (GH-29230) (GH-29241)

ned-deily webhook-mailer at python.org
Wed Oct 27 11:04:53 EDT 2021


https://github.com/python/cpython/commit/30c1f18ee62cef301e18488b80b4d329290f7b95
commit: 30c1f18ee62cef301e18488b80b4d329290f7b95
branch: 3.9
author: Ned Deily <nad at python.org>
committer: ned-deily <nad at python.org>
date: 2021-10-27T11:04:38-04:00
summary:

[3.9] bpo-45618: Fix documentation build by pinning Docutils version to 0.17.1 (GH-29230) (GH-29241)

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

files:
M .azure-pipelines/docs-steps.yml
M Doc/requirements.txt

diff --git a/.azure-pipelines/docs-steps.yml b/.azure-pipelines/docs-steps.yml
index eaf4ad01927ae..647daff7a033a 100644
--- a/.azure-pipelines/docs-steps.yml
+++ b/.azure-pipelines/docs-steps.yml
@@ -12,11 +12,12 @@ steps:
   inputs:
     versionSpec: '>=3.6'
 
-- script: python -m pip install sphinx==2.2.0 blurb python-docs-theme
+- script: python -m pip install -r requirements.txt
+  workingDirectory: '$(build.sourcesDirectory)/Doc'
   displayName: 'Install build dependencies'
 
 - ${{ if ne(parameters.latex, 'true') }}:
-  - script: make check suspicious html PYTHON=python
+  - script: make check html PYTHON=python
     workingDirectory: '$(build.sourcesDirectory)/Doc'
     displayName: 'Build documentation'
 
@@ -31,7 +32,7 @@ steps:
 - ${{ if eq(parameters.upload, 'true') }}:
   - task: PublishBuildArtifacts at 1
     displayName: 'Publish docs'
-  
+
     inputs:
       PathToPublish: '$(build.sourcesDirectory)/Doc/build'
       ArtifactName: docs
diff --git a/Doc/requirements.txt b/Doc/requirements.txt
index 47b78eeac817e..cb21ed20397b2 100644
--- a/Doc/requirements.txt
+++ b/Doc/requirements.txt
@@ -4,6 +4,10 @@
 # won't suddenly cause build failures. Updating the version is fine as long
 # as no warnings are raised by doing so.
 sphinx==2.4.4
+# Docutils version is pinned to a version compatible with Sphinx
+# version 2.4.4. It can be removed after bumping Sphinx version to at
+# least 3.5.4.
+docutils==0.17.1
 
 blurb
 



More information about the Python-checkins mailing list