◐ Shell
reader mode source ↗
Skip to content

Travis CI: run rstlint.py in the docs job#68

Merged
vstinner merged 1 commit into
python:masterfrom
vstinner:travis_doc_linter
Feb 13, 2017
Merged

Travis CI: run rstlint.py in the docs job#68
vstinner merged 1 commit into
python:masterfrom
vstinner:travis_doc_linter

Conversation

@vstinner

Copy link
Copy Markdown
Member

Currently, http://buildbot.python.org/all/buildslaves/ware-docs
buildbot is only run as post-commit. For example, bpo-29521 (PR#41)
introduced two warnings, unnotified by the Travis CI docs job.

Modify the docs job to run toosl/rstlint.py.

Fix also the two minor warnings which causes the buildbot slave to
fail.

Currently, http://buildbot.python.org/all/buildslaves/ware-docs
buildbot is only run as post-commit. For example, bpo-29521 (PR#41)
introduced two warnings, unnotified by the Travis CI docs job.

Modify the docs job to run toosl/rstlint.py.

Fix also the two minor warnings which causes the buildbot slave to
fail.
@vstinner vstinner added docs Documentation in the Doc dir tests Tests in the Lib/test dir labels Feb 13, 2017
@vstinner vstinner merged commit 2b50186 into python:master Feb 13, 2017
@JDLH

JDLH commented Feb 13, 2017

Copy link
Copy Markdown
Contributor

Thank you for catching this. I authored the trailing spaces in those two lines.
My "test suite" for the documentation was make html. I didn't know to run rstlint.py as well.

It would have helped me to have this check in some sort of make test in Doc/Makefile. It would also have helped me to have a reference to this doc testing in https://cpython-devguide.readthedocs.io/docquality.html .

@vstinner

vstinner commented Feb 13, 2017 via email

Copy link
Copy Markdown
Member Author

@zware

zware commented Feb 14, 2017

Copy link
Copy Markdown
Member

Note that running rstlint is available as make check.

methane referenced this pull request in methane/cpython Feb 14, 2017
Currently, http://buildbot.python.org/all/buildslaves/ware-docs
buildbot is only run as post-commit. For example, bpo-29521 (PR#41)
introduced two warnings, unnotified by the Travis CI docs job.

Modify the docs job to run toosl/rstlint.py.

Fix also the two minor warnings which causes the buildbot slave to
fail.
methane referenced this pull request in methane/cpython Feb 14, 2017
Currently, http://buildbot.python.org/all/buildslaves/ware-docs
buildbot is only run as post-commit. For example, bpo-29521 (PR#41)
introduced two warnings, unnotified by the Travis CI docs job.

Modify the docs job to run toosl/rstlint.py.

Fix also the two minor warnings which causes the buildbot slave to
fail.
@berkerpeksag

Copy link
Copy Markdown
Member

Note that running rstlint is available as make check.

Good point, opened #96. Thanks!

vstinner added a commit that referenced this pull request Feb 15, 2017
* Travis CI: run rstlint.py in the docs job (#68)

Currently, http://buildbot.python.org/all/buildslaves/ware-docs
buildbot is only run as post-commit. For example, bpo-29521 (PR#41)
introduced two warnings, unnotified by the Travis CI docs job.

Modify the docs job to run toosl/rstlint.py.

Fix also the two minor warnings which causes the buildbot slave to
fail.
(cherry picked from commit 2b50186)

* Doc/Makefile: set PYTHON to python3 (#124)

rstlint.py run by "make check" doesn't support Python 2.

"make venv" runs "$(PYTHON) -m venv", whereas Python 2 doens't
provide the venv module: it's a module of Python 3 standard library.

(cherry picked from commit 91b0e7d)
vstinner added a commit that referenced this pull request Feb 16, 2017
* Travis CI: run rstlint.py in the docs job (#68)

Currently, http://buildbot.python.org/all/buildslaves/ware-docs
buildbot is only run as post-commit. For example, bpo-29521 (PR#41)
introduced two warnings, unnotified by the Travis CI docs job.

Modify the docs job to run toosl/rstlint.py.

Fix also the two minor warnings which causes the buildbot slave to
fail.
(cherry picked from commit 2b50186)

* Doc/Makefile: set PYTHON to python3 (#124)

rstlint.py run by "make check" doesn't support Python 2.

"make venv" runs "$(PYTHON) -m venv", whereas Python 2 doens't
provide the venv module: it's a module of Python 3 standard library.

(cherry picked from commit 91b0e7d)
(cherry picked from commit b300c66)
ncoghlan pushed a commit that referenced this pull request Feb 19, 2017
* Add .travis.yml to 3.6 branch

* Travis CI: run rstlint.py in the docs job (#68)

Currently, http://buildbot.python.org/all/buildslaves/ware-docs
buildbot is only run as post-commit. For example, bpo-29521 (PR#41)
introduced two warnings, unnotified by the Travis CI docs job.

Modify the docs job to run toosl/rstlint.py.

Fix also the two minor warnings which causes the buildbot slave to
fail.

* Only run CI checks when appropriate files have changed (#74)

Closes python/core-workflow#14

* Use 'make check' instead of 'python3 tools/rstlint.py' (#96)
ncoghlan pushed a commit that referenced this pull request Feb 19, 2017
* Add .travis.yml to 3.5 branch

* Only run CI checks when appropriate files have changed (#74)

Closes python/core-workflow#14

* Travis CI: run rstlint.py in the docs job (#68)

Currently, http://buildbot.python.org/all/buildslaves/ware-docs
buildbot is only run as post-commit. For example, bpo-29521 (PR#41)
introduced two warnings, unnotified by the Travis CI docs job.

Modify the docs job to run toosl/rstlint.py.

Fix also the two minor warnings which causes the buildbot slave to
fail.

* Use 'make check' instead of 'python3 tools/rstlint.py' (#96)
@vstinner vstinner deleted the travis_doc_linter branch June 15, 2017 23:06
jaraco pushed a commit that referenced this pull request Dec 2, 2022
jaraco added a commit to jaraco/cpython that referenced this pull request Feb 17, 2023
jaraco pushed a commit to jaraco/cpython that referenced this pull request Feb 17, 2023
…hat `.readthedocs.yml` will be deprecated) (python#68)
119 hidden items Load more…
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs Documentation in the Doc dir tests Tests in the Lib/test dir

Projects

None yet

Development

Successfully merging this pull request may close these issues.

6 participants