update contributing.md

This commit is contained in:
Nir 2023-05-29 10:14:39 +03:00
parent 0b152f0dd3
commit 6e1e2f62e8
1 changed files with 14 additions and 0 deletions

View File

@ -135,6 +135,20 @@ other people can use it as well. This section collects some technical
information that you will need for updating Catch2's documentation, and information that you will need for updating Catch2's documentation, and
possibly some generic advise as well. possibly some generic advise as well.
We use mkdocs for documentation and poetry for python environment.
first install poetry (you'll need python...)
```console
pip install poetry
```
Poetry will install our docs dependencies
```console
poetry install
```
serve the docs locally to see your changes
```console
poetry run mkdocs serve
```
### Technicalities ### Technicalities