Skip to content

Commit

Permalink
Added some docs to setup sphinx local environment
Browse files Browse the repository at this point in the history
  • Loading branch information
e-dong committed Aug 13, 2023
1 parent 3017a40 commit 423cb47
Show file tree
Hide file tree
Showing 2 changed files with 23 additions and 0 deletions.
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,9 @@ cmake-build*
node_modules/
package-lock.json

# python
*env*/

# Translations
*.mo
*.pot
20 changes: 20 additions & 0 deletions docs/README.md
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`

0 comments on commit 423cb47

Please sign in to comment.