feat: Run doc8 via pre-commit

Author: l0b0

.pre-commit-config.yaml

@@ -11,6 +11,13 @@ repos:
         stages: [commit]
         types: [python]
 
+      - id: doc8
+        name: doc8
+        entry: doc8
+        language: system
+        files: \.rst$
+        require_serial: true
+
       - id: flake8
         name: flake8
         entry: flake8

docs/contributing.rst

@@ -45,26 +45,20 @@ More details on using ``unittest`` are `here
 Code quality checks
 ^^^^^^^^^^^^^^^^^^^
 
-PySTAC uses `flake8 <http://flake8.pycqa.org/en/latest/>`_ and `black
-<https://github.com/psf/black>`_ for code formatting and style checks.
+PySTAC uses
 
-To run both:
+- `black <https://github.com/psf/black>`_ for Python code formatting
+- `doc8 <https://github.com/pycqa/doc8>`__ for style checking on RST files in the docs
+- `flake8 <http://flake8.pycqa.org/en/latest/>`_ for Python style checks
+- `mypy <http://www.mypy-lang.org/>`_ for Python type annotation checks
 
-.. code-block:: bash
-
-    > pre-commit run --all-files
-
-We also use `doc8 <https://github.com/pycqa/doc8>`__ for style checking on RST files in
-the docs.
-
-To check doc formatting:
+To run all of these:
 
 .. code-block:: bash
 
-    > doc8 docs
+    > pre-commit run --all-files
 
-You can also run the ``./scripts/test`` script to run unit tests, check code style with
-``flake8`` and ``black``, and check type annotations using ``mypy``.
+You can also run the ``./scripts/test`` script to run all of the above and unit tests.
 
 CHANGELOG
 ^^^^^^^^^

scripts/lint

@@ -3,7 +3,7 @@
 set -e
 
 echo
-echo " -- CHECKING WITH BLACK, FLAKE8 AND MYPY --"
+echo " -- CHECKING WITH BLACK, DOC8, FLAKE8 AND MYPY --"
 echo
 
 pre-commit run --all-files
@@ -12,13 +12,6 @@ echo
 echo " -- CHECKING SPELLING WITH CODESPELL --"
 echo
 
-echo
-echo " -- LINTING RST FILES WITH DOC8 --"
-echo
-
-doc8 docs -q
-
-
 # Code spelling
 codespell -I .codespellignore -f \
     pystac/*.py pystac/**/*.py \