Skip to content

Commit c36ba2d

Browse files
committed
README: hint on the optional requirements for docs and tests
1 parent 2a53f92 commit c36ba2d

File tree

1 file changed

+9
-4
lines changed

1 file changed

+9
-4
lines changed

README.md

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -96,6 +96,10 @@ the dependencies with:
9696

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

99+
or install them with pip using:
100+
101+
pip install osmium[tests]
102+
99103
The test suite can be run with:
100104

101105
pytest test
@@ -104,12 +108,13 @@ The test suite can be run with:
104108
## Documentation
105109

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

111-
sudo apt-get install mkdocs mkdocstrings mkdocstrings-python-handlers\
112-
mkdocs-material mkdocs-material-extensions
115+
All necessary packages can be installed via pip:
116+
117+
pip install osmium[docs]
113118

114119
To build the documentation run:
115120

0 commit comments

Comments
 (0)