Skip to content

Commit

Permalink
restructuredtext-lint -> rstcheck in README and TravisCI
Browse files Browse the repository at this point in the history
  • Loading branch information
peterjc committed Mar 9, 2020
1 parent ab417e9 commit a65da8c
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 6 deletions.
6 changes: 3 additions & 3 deletions .travis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -24,10 +24,10 @@ before_install:
- "if grep '\t' *.py *.rst; then echo 'Tabs are bad, please use four spaces.'; false; fi"
- "if grep -n -r '[[:blank:]]$' *.py *.rst; then echo 'Please remove trailing whitespace.'; false; fi"
- pip install --upgrade pip setuptools
- pip install flake8 flake8-docstrings restructuredtext-lint
- pip install flake8 flake8-docstrings rstcheck
- "if [[ $TRAVIS_PYTHON_VERSION == '3.6' ]]; then pip install flake8-black; fi"
- echo "Using restructuredtext-lint to check documentation"
- restructuredtext-lint *.rst
- echo "Using rstcheck to check documentation"
- rstcheck *.rst
- echo "Using flake8 to check Python code"
- flake8 setup.py flake8_rst_docstrings.py

Expand Down
7 changes: 4 additions & 3 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -32,10 +32,9 @@ has a flake8 plugin called ``flake8-docstrings``, see:
- https://github.com/PyCQA/flake8-docstrings

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

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

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

0 comments on commit a65da8c

Please sign in to comment.