From 302903b89c2a5be6148a8b258387b437fa2da698 Mon Sep 17 00:00:00 2001 From: Sonny Piers Date: Sat, 17 Sep 2022 22:37:00 +0200 Subject: [PATCH] doc: Add documentation to contribute --- CONTRIBUTING.md | 17 ++++++++++++++++- 1 file changed, 16 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index b7690a2..d817250 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -4,6 +4,21 @@ If you learn something useful, please add it to this file. # Run the test suite -``` +```sh python -m unittest ``` + +# Build the docs + +```sh +pip install -U sphinx furo + +meson -Ddocs=true build +# or +meson --reconfigure -Ddocs=true build + +ninja -C build docs/en + +python -m http.server 2310 --bind 127.0.0.1 --directory build/docs/en/ +xdg-open http://127.0.0.1:2310/ +```