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 09c2045 commit 8127aba
Show file tree
Hide file tree
Showing 3 changed files with 10 additions and 5 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
11 changes: 8 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,9 @@ Installation
Instructions
------------

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

Install *pandoc-beamer-block* using the bash command

Expand All @@ -45,7 +47,9 @@ To upgrade to the most recent release, use
$ pipx upgrade pandoc-beamer-block
~~~

`pipx` is a script to install and run python applications in isolated environments from the Python Package Index, [PyPI]. It can be installed using instructions given [here](https://pipx.pypa.io/stable/).
`pipx` is a script to install and run python applications in isolated
environments from the Python Package Index, [PyPI]. It can be installed
using instructions given [here](https://pipx.pypa.io/stable/).

[python]: https://www.python.org
[on Windows]: https://www.python.org/downloads/windows
Expand All @@ -55,7 +59,8 @@ $ pipx upgrade pandoc-beamer-block
Getting Help
------------

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

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

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_beamer_block
poetry run black --check --diff pandoc_beamer_block tests
poetry run doc8 -q docs
poetry run doc8 -q docs README.md -e .rst -e .md
poetry run mypy pandoc_beamer_block
poetry run flake8 pandoc_beamer_block
commands_post =
Expand Down

0 comments on commit 8127aba

Please sign in to comment.