Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
kiraware committed Jan 20, 2024
1 parent ba8f0d0 commit aba4e57
Showing 1 changed file with 9 additions and 2 deletions.
11 changes: 9 additions & 2 deletions docs/how-to-guides.md
Original file line number Diff line number Diff line change
Expand Up @@ -72,8 +72,15 @@ poetry run poe test
### Documenting

We use [Material for MkDocs](https://squidfunk.github.io/mkdocs-material/)
as static site documentation with markdown. To run development mode
you can use the following command:
as static site documentation with markdown. PyBMKG does not include
docs dependencies by default, to install it you can use the
following command:

```console
poetry install --with docs
```

To run development mode you can use the following command:

```console
poetry run mkdocs serve
Expand Down

0 comments on commit aba4e57

Please sign in to comment.