From 2a3c2759b83adf68cbfbed2f2e732ac56140b91e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Felix=20Geisend=C3=B6rfer?= Date: Tue, 27 Dec 2022 14:41:07 +0100 Subject: [PATCH] wip --- CONTRIBUTING.md | 19 +++++++------------ 1 file changed, 7 insertions(+), 12 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 4c9d327..ce9eb15 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,22 +1,17 @@ # 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 -make html -``` - -3. Open the HTML in your web browser - -``` -open _build/html/index.html +sphinx-autobuild docs/ docs/_build/html/ ```