Skip to content

Commit

Permalink
README: hint on the optional requirements for docs and tests
Browse files Browse the repository at this point in the history
  • Loading branch information
lonvia committed Sep 20, 2024
1 parent 2a53f92 commit c36ba2d
Showing 1 changed file with 9 additions and 4 deletions.
13 changes: 9 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -96,6 +96,10 @@ the dependencies with:

sudo apt-get install python3-pytest python3-pytest-httpserver

or install them with pip using:

pip install osmium[tests]

The test suite can be run with:

pytest test
Expand All @@ -104,12 +108,13 @@ The test suite can be run with:
## Documentation

To build the documentation you need [mkdocs](https://www.mkdocs.org/)
with the [mkdocstrings extension](https://mkdocstrings.github.io/)
with the [mkdocstrings](https://mkdocstrings.github.io/)
and [jupyter](https://github.com/danielfrg/mkdocs-jupyter) extensions
and the [material theme](https://squidfunk.github.io/mkdocs-material/).
On Debian/Ubuntu install

sudo apt-get install mkdocs mkdocstrings mkdocstrings-python-handlers\
mkdocs-material mkdocs-material-extensions
All necessary packages can be installed via pip:

pip install osmium[docs]

To build the documentation run:

Expand Down

0 comments on commit c36ba2d

Please sign in to comment.