Skip to content

Commit 2c5460e

Browse files
committed
Check README.rst with rstcheck
1 parent b082d78 commit 2c5460e

File tree

4 files changed

+204
-5
lines changed

4 files changed

+204
-5
lines changed

Makefile

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ format:
1010
lint:
1111
@poetry run pylint ./makenew_pypackage
1212
@poetry run black --check .
13+
@poetry run rstcheck README.rst
1314

1415
test:
1516
@poetry run pytest --cov=./makenew_pypackage

README.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -28,15 +28,15 @@ Features
2828
- Uncompromising code formatting with Black_.
2929
- pytest_ helps you write better programs.
3030
- Code coverage reporting with Codecov_.
31-
- Continuous testing and deployment with `GitHub Actions`_.
31+
- Continuous testing and deployment with `GitHub Actions`__.
3232
- `Keep a CHANGELOG`_.
3333
- Consistent coding with EditorConfig_.
3434
- Badges from Shields.io_.
3535

3636
.. _Black: https://black.readthedocs.io/en/stable/
3737
.. _Codecov: https://codecov.io/
3838
.. _EditorConfig: https://editorconfig.org/
39-
.. _GitHub Actions: https://github.com/features/actions
39+
.. __: https://github.com/features/actions
4040
.. _Keep a CHANGELOG: https://keepachangelog.com/
4141
.. _PyPI: https://pypi.python.org/pypi
4242
.. _Pylint: https://www.pylint.org/
@@ -163,14 +163,14 @@ Primary development tasks are defined in the `Makefile`.
163163
Source Code
164164
~~~~~~~~~~~
165165

166-
The `source code`_ is hosted on GitHub.
166+
The `source code`__ is hosted on GitHub.
167167
Clone the project with
168168

169169
::
170170

171171
$ git clone https://github.com/makenew/pypackage.git
172172

173-
.. _source code: https://github.com/makenew/pypackage
173+
.. __: https://github.com/makenew/pypackage
174174

175175
Requirements
176176
~~~~~~~~~~~~

poetry.lock

Lines changed: 198 additions & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

pyproject.toml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@ pytest = "^7.1.1"
1818
pytest-cov = "^4.0.0"
1919
pytest-runner = "^6.0.0"
2020
pytest-watch = "^4.2.0"
21+
rstcheck = "^6.1.2"
2122

2223
[build-system]
2324
requires = ["poetry>=1.2"]

0 commit comments

Comments
 (0)