Skip to content

bpo-46016: GHA Doc job now also runs "make check"#30009

Merged
vstinner merged 1 commit intopython:mainfrom
vstinner:gha_doc_check
Dec 9, 2021
Merged

bpo-46016: GHA Doc job now also runs "make check"#30009
vstinner merged 1 commit intopython:mainfrom
vstinner:gha_doc_check

Conversation

@vstinner
Copy link
Copy Markdown
Member

@vstinner vstinner commented Dec 9, 2021 •
edited by bedevere-bot
Loading

The GitHub Action documentation job now also runs "make check" to
check the documentation.

https://bugs.python.org/issue46016

@vstinner
Copy link
Copy Markdown
Member Author

vstinner commented Dec 9, 2021

The second commit should be removed, it's just to trigger the Docs CI job.

@vstinner
Copy link
Copy Markdown
Member Author

vstinner commented Dec 9, 2021

cc @tiran

@vstinner
Copy link
Copy Markdown
Member Author

vstinner commented Dec 9, 2021

cc @JulienPalard

@vstinner
Copy link
Copy Markdown
Member Author

vstinner commented Dec 9, 2021

Oh, the job failed when the xvfb-run command was run twice:

xvfb-run make -C Doc/ PYTHON=../python SPHINXOPTS="-q -W --keep-going -j4" check
xvfb-run make -C Doc/ PYTHON=../python SPHINXOPTS="-q -W --keep-going -j4" doctest

The second run failed with:

xvfb-run: error: Xvfb failed to start

I modified the config to only use xvfb-run to run doctest.

@vstinner
Copy link
Copy Markdown
Member Author

vstinner commented Dec 9, 2021

Docs / Docs (pull_request) Successful

Good. The 3 doc tests passed!

@vstinner
Copy link
Copy Markdown
Member Author

vstinner commented Dec 9, 2021 •
edited by bedevere-bot
Loading

I reverted [bpo-46016](https://bugs.python.org/issue46016): Fix rest syntax of GH-29993 (GH-30006) fix on purpose to make sure that GHA Doc job now catchs the bug.

@vstinner
Copy link
Copy Markdown
Member Author

vstinner commented Dec 9, 2021

I reverted bpo-46016: Fix rest syntax of GH-29993 (GH-30006) fix on purpose to make sure that GHA Doc job now catchs the bug.

Good! The new check catches the bug:

Docs / Docs (pull_request) Failing

Run make -C Doc/ PYTHON=../python SPHINXOPTS="-q -W --keep-going -j4" check
make: Entering directory '/home/runner/work/cpython/cpython/Doc'
../python tools/rstlint.py -i tools -i ./venv -i README.rst
Error: [2] whatsnew/3.11.rst:335: default role used

@vstinner
bpo-46016: GHA Doc job now also runs "make check"
312c4b4 
The GitHub Action documentation job now also runs "make check" to
check the documentation.
@vstinner
Copy link
Copy Markdown
Member Author

vstinner commented Dec 9, 2021

@tiran @JulienPalard: the PR works as expected, it's now awaiting for your review :-)

@vstinner
Copy link
Copy Markdown
Member Author

vstinner commented Dec 9, 2021

I reverted my 2 commits used to test the CI job.

@vstinner vstinner merged commit da3cf43 into python:main Dec 9, 2021
@vstinner vstinner deleted the gha_doc_check branch December 9, 2021 23:02
This was referenced Jan 5, 2022
Merged
Closed
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

Assignees

No one assigned

Labels

skip news

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@vstinner @erlend-aasland @the-knights-who-say-ni @bedevere-bot