forked from LizardByte/Sunshine
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Added some docs to setup sphinx local environment
- Loading branch information
Showing
2 changed files
with
23 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -13,6 +13,9 @@ cmake-build* | |
node_modules/ | ||
package-lock.json | ||
|
||
# python | ||
*env*/ | ||
|
||
# Translations | ||
*.mo | ||
*.pot |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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 <name_of_env>`. This will store the python dependencies for generating the sphinx documentation. | ||
2. Activate the environment with `./<name_of_env>/bin/activate` | ||
3. Install python dependencies with `pip install -r requirements.txt` | ||
|
||
### Generating Documentation | ||
Execute `make html` to generate html documentation into `docs/builds` | ||
|