This commit is contained in:
Felix Geisendörfer 2022-12-27 14:41:07 +01:00
parent edb8883543
commit 2a3c2759b8

View file

@ -1,22 +1,17 @@
# Contributing # Contributing
To build the contents of this repository locally, follow the steps below. ## Local Development
1. Install sphinx and the read the docs theme For local development, follow the steps below:
1. Install dependencies
``` ```
pip install sphinx sphinx-rtd-theme pip install sphinx sphinx-rtd-theme sphinx-autobuild sphinxemoji
``` ```
2. Build the HTML 2. Run the development server
``` ```
cd docs sphinx-autobuild docs/ docs/_build/html/
make html
```
3. Open the HTML in your web browser
```
open _build/html/index.html
``` ```