Skip to content

Commit a65da8c

Browse files
committed
restructuredtext-lint -> rstcheck in README and TravisCI
1 parent ab417e9 commit a65da8c

2 files changed

Lines changed: 7 additions & 6 deletions

File tree

.travis.yml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -24,10 +24,10 @@ before_install:
2424
- "if grep '\t' *.py *.rst; then echo 'Tabs are bad, please use four spaces.'; false; fi"
2525
- "if grep -n -r '[[:blank:]]$' *.py *.rst; then echo 'Please remove trailing whitespace.'; false; fi"
2626
- pip install --upgrade pip setuptools
27-
- pip install flake8 flake8-docstrings restructuredtext-lint
27+
- pip install flake8 flake8-docstrings rstcheck
2828
- "if [[ $TRAVIS_PYTHON_VERSION == '3.6' ]]; then pip install flake8-black; fi"
29-
- echo "Using restructuredtext-lint to check documentation"
30-
- restructuredtext-lint *.rst
29+
- echo "Using rstcheck to check documentation"
30+
- rstcheck *.rst
3131
- echo "Using flake8 to check Python code"
3232
- flake8 setup.py flake8_rst_docstrings.py
3333

README.rst

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -32,10 +32,9 @@ has a flake8 plugin called ``flake8-docstrings``, see:
3232
- https://github.com/PyCQA/flake8-docstrings
3333

3434
The reStructuredText (RST) validation is done by calling ``docutils`` via
35-
Todd Wolfson's ``restructuredtext-lint`` code:
35+
Steven Myint's ``rstcheck`` code:
3636

37-
- http://docutils.sourceforge.net/
38-
- https://github.com/twolfson/restructuredtext-lint
37+
- https://github.com/myint/rstcheck
3938

4039
I recommend you *also* install the related `flake8-docstrings
4140
<https://gitlab.com/pycqa/flake8-docstrings>`_ plugin, which brings
@@ -219,6 +218,8 @@ Version History
219218
======= ========== ===========================================================
220219
Version Released Changes
221220
------- ---------- -----------------------------------------------------------
221+
v0.1.0 *Pending* - Switched from ``restructuredtext-lint`` to ``rstcheck``
222+
which also checks syntax of any code blocks within RST.
222223
v0.0.13 2019-12-26 - Adds ``RST218`` and ``RST219``.
223224
v0.0.12 2019-11-18 - Adds ``RST213`` to ``RST217``.
224225
v0.0.11 2019-08-07 - Configuration options to define additional directives and

0 commit comments

Comments
 (0)