Skip to content

Commit

Permalink
Fix docs
Browse files Browse the repository at this point in the history
  • Loading branch information
chdemko committed Aug 3, 2024
1 parent bcd32c8 commit e08d144
Show file tree
Hide file tree
Showing 3 changed files with 11 additions and 7 deletions.
2 changes: 1 addition & 1 deletion .pre-commit-config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ repos:
rev: v1.1.1
hooks:
- id: doc8
args: [docs]
args: [docs, README.md, -e, .rst, -e, .md]

- repo: https://github.com/pre-commit/mirrors-mypy
rev: v1.11.0
Expand Down
14 changes: 9 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,9 @@ Install
Instructions
------------

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

Install *pandoc-numbering* using the bash command

Expand All @@ -52,8 +54,8 @@ Make sure you have the
* *tocloft*

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

~~~shell
$ sudo apt-get install texlive-latex-extra
Expand All @@ -67,7 +69,8 @@ $ sudo apt-get install texlive-latex-extra
Getting Help
------------

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

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

Expand All @@ -84,7 +87,8 @@ $ poetry install
$ poetry shell
~~~

And submit your changes. When you commit, hooks will be executed to check your code.
And submit your changes. When you commit, hooks will be executed to check
your code.

Notes
=====
Expand Down
2 changes: 1 addition & 1 deletion tox.ini
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ commands =
poetry run teyit --show-stats --fail-on-change tests/
poetry run ruff check pandoc_numbering
poetry run black --check --diff pandoc_numbering tests
poetry run doc8 -q docs
poetry run doc8 -q docs README.md -e .rst -e .md
poetry run mypy pandoc_numbering
poetry run flake8 pandoc_numbering
commands_post =
Expand Down

0 comments on commit e08d144

Please sign in to comment.