Skip to content

Commit e08d144

Browse files
committed
Fix docs
1 parent bcd32c8 commit e08d144

File tree

3 files changed

+11
-7
lines changed

3 files changed

+11
-7
lines changed

.pre-commit-config.yaml

+1-1
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ repos:
5858
rev: v1.1.1
5959
hooks:
6060
- id: doc8
61-
args: [docs]
61+
args: [docs, README.md, -e, .rst, -e, .md]
6262

6363
- repo: https://github.com/pre-commit/mirrors-mypy
6464
rev: v1.11.0

README.md

+9-5
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,9 @@ Install
3131
Instructions
3232
------------
3333

34-
*pandoc-numbering* requires [python], a programming language that comes pre-installed on linux and Mac OS X, and which is easily installed [on Windows].
34+
*pandoc-numbering* requires [python], a programming language that comes
35+
pre-installed on linux and Mac OS X, and which is easily installed
36+
[on Windows].
3537

3638
Install *pandoc-numbering* using the bash command
3739

@@ -52,8 +54,8 @@ Make sure you have the
5254
* *tocloft*
5355

5456
LaTeX package. On linux you have to install some extra libraries **before**
55-
*pandoc-numbering*. On a Debian-based system (including Ubuntu), you can install it as
56-
root using
57+
*pandoc-numbering*. On a Debian-based system (including Ubuntu), you can
58+
install it as root using
5759

5860
~~~shell
5961
$ sudo apt-get install texlive-latex-extra
@@ -67,7 +69,8 @@ $ sudo apt-get install texlive-latex-extra
6769
Getting Help
6870
------------
6971

70-
If you have any difficulties with *pandoc-numbering*, please feel welcome to [file an issue] on github so that we can help.
72+
If you have any difficulties with *pandoc-numbering*, please feel welcome to
73+
[file an issue] on github so that we can help.
7174

7275
[file an issue]: https://github.com/chdemko/pandoc-numbering/issues
7376

@@ -84,7 +87,8 @@ $ poetry install
8487
$ poetry shell
8588
~~~
8689

87-
And submit your changes. When you commit, hooks will be executed to check your code.
90+
And submit your changes. When you commit, hooks will be executed to check
91+
your code.
8892

8993
Notes
9094
=====

tox.ini

+1-1
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ commands =
2727
poetry run teyit --show-stats --fail-on-change tests/
2828
poetry run ruff check pandoc_numbering
2929
poetry run black --check --diff pandoc_numbering tests
30-
poetry run doc8 -q docs
30+
poetry run doc8 -q docs README.md -e .rst -e .md
3131
poetry run mypy pandoc_numbering
3232
poetry run flake8 pandoc_numbering
3333
commands_post =

0 commit comments

Comments
 (0)