Check README.rst with rstcheck

makenew · Jul 25, 2023 · 2c5460e · 2c5460e
1 parent b082d78
commit 2c5460e
Show file tree

Hide file tree

Showing 4 changed files with 204 additions and 5 deletions.
diff --git a/Makefile b/Makefile
@@ -10,6 +10,7 @@ format:
 lint:
 	@poetry run pylint ./makenew_pypackage
 	@poetry run black --check .
+	@poetry run rstcheck README.rst
 
 test:
 	@poetry run pytest --cov=./makenew_pypackage

diff --git a/README.rst b/README.rst
@@ -28,15 +28,15 @@ Features
 - Uncompromising code formatting with Black_.
 - pytest_ helps you write better programs.
 - Code coverage reporting with Codecov_.
-- Continuous testing and deployment with `GitHub Actions`_.
+- Continuous testing and deployment with `GitHub Actions`__.
 - `Keep a CHANGELOG`_.
 - Consistent coding with EditorConfig_.
 - Badges from Shields.io_.
 
 .. _Black: https://black.readthedocs.io/en/stable/
 .. _Codecov: https://codecov.io/
 .. _EditorConfig: https://editorconfig.org/
-.. _GitHub Actions: https://github.com/features/actions
+.. __: https://github.com/features/actions
 .. _Keep a CHANGELOG: https://keepachangelog.com/
 .. _PyPI: https://pypi.python.org/pypi
 .. _Pylint: https://www.pylint.org/
@@ -163,14 +163,14 @@ Primary development tasks are defined in the `Makefile`.
 Source Code
 ~~~~~~~~~~~
 
-The `source code`_ is hosted on GitHub.
+The `source code`__ is hosted on GitHub.
 Clone the project with
 
 ::
 
     $ git clone https://github.com/makenew/pypackage.git
 
-.. _source code: https://github.com/makenew/pypackage
+.. __: https://github.com/makenew/pypackage
 
 Requirements
 ~~~~~~~~~~~~

diff --git a/poetry.lock b/poetry.lock
diff --git a/pyproject.toml b/pyproject.toml
@@ -18,6 +18,7 @@ pytest = "^7.1.1"
 pytest-cov = "^4.0.0"
 pytest-runner = "^6.0.0"
 pytest-watch = "^4.2.0"
+rstcheck = "^6.1.2"
 
 [build-system]
 requires = ["poetry>=1.2"]