From e08d1448984f707b9db7863d02665d75272f1403 Mon Sep 17 00:00:00 2001 From: Christophe Demko Date: Sat, 3 Aug 2024 11:21:23 +0200 Subject: [PATCH] Fix docs --- .pre-commit-config.yaml | 2 +- README.md | 14 +++++++++----- tox.ini | 2 +- 3 files changed, 11 insertions(+), 7 deletions(-) diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index 4d64463..0d6b82b 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -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 diff --git a/README.md b/README.md index 6be784a..1404683 100644 --- a/README.md +++ b/README.md @@ -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 @@ -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 @@ -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 @@ -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 ===== diff --git a/tox.ini b/tox.ini index ddc2ca2..7215361 100644 --- a/tox.ini +++ b/tox.ini @@ -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 =