Skip to content

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

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

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

Conversation

@vstinner

@vstinner vstinner commented Dec 9, 2021

Copy link
Copy Markdown
Member

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

https://bugs.python.org/issue46016

@vstinner

vstinner commented Dec 9, 2021

Copy link
Copy Markdown
Member Author

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

@vstinner

vstinner commented Dec 9, 2021

Copy link
Copy Markdown
Member Author

cc @tiran

@vstinner

vstinner commented Dec 9, 2021

Copy link
Copy Markdown
Member Author

cc @JulienPalard

@vstinner

vstinner commented Dec 9, 2021

Copy link
Copy Markdown
Member Author

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

vstinner commented Dec 9, 2021

Copy link
Copy Markdown
Member Author

Docs / Docs (pull_request) Successful

Good. The 3 doc tests passed!

@vstinner

vstinner commented Dec 9, 2021

Copy link
Copy Markdown
Member Author

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

vstinner commented Dec 9, 2021

Copy link
Copy Markdown
Member Author

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

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

vstinner commented Dec 9, 2021

Copy link
Copy Markdown
Member Author

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

@vstinner

vstinner commented Dec 9, 2021

Copy link
Copy Markdown
Member Author

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
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants