mirror of
https://github.com/catchorg/Catch2.git
synced 2024-11-16 18:52:25 +01:00
update contributing.md
This commit is contained in:
parent
0b152f0dd3
commit
6e1e2f62e8
@ -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
|
||||||
|
|
||||||
|
Loading…
Reference in New Issue
Block a user