diff --git a/.gitignore b/.gitignore index c3a04d9652d..34f4baa787f 100644 --- a/.gitignore +++ b/.gitignore @@ -13,6 +13,9 @@ cmake-build* node_modules/ package-lock.json +# python +*env*/ + # Translations *.mo *.pot diff --git a/docs/README.md b/docs/README.md new file mode 100644 index 00000000000..95a11bc04a9 --- /dev/null +++ b/docs/README.md @@ -0,0 +1,20 @@ +# Contributing to Sunshine Docs + +Please read the [organizational level contribution](https://docs.lizardbyte.dev/en/latest/developers/contributing.html) docs first. + +## Local Dev Environment + +### Prerequisites +Install the following (latest versions should be fine): +* python +* doxygen + +### Setup +1. cd into `docs` +1. Create a python virtual environment with: `python -m venv `. This will store the python dependencies for generating the sphinx documentation. +2. Activate the environment with `.//bin/activate` +3. Install python dependencies with `pip install -r requirements.txt` + +### Generating Documentation +Execute `make html` to generate html documentation into `docs/builds` +