Start9/documentation
2
0
Fork 0
mirror of https://github.com/Start9Labs/documentation.git synced 2026-03-26 02:11:55 +00:00
Code Issues Packages Projects Releases Wiki Activity

update readme

Browse Source
This commit is contained in:
Lucy Cifferello
2020-10-06 20:42:15 -06:00
parent 1f075a1d58
commit 5051289305
1 changed files with 18 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

24
README.md
View File

@@ -1,11 +1,23 @@
# Embassy Documentation
# Start9 Labs Documentation
## Contributing
## Environment Setup
### Environment Setup
Install [python3](https://docs.python-guide.org/starting/install3/osx/)
pip install sphinx-autobuild
Install sphinx: `brew install sphinx-doc`
### To Develop
Python dependencies:
```
pip3 install sphinx-autobuild
pip3 install sphinx-book-theme
```
sphinx-autobuild source build/html
## To Develop
This project uses [Sphinx](https://www.sphinx-doc.org/en/master/usage/installation.html) and [Restructured Text](https://thomas-cokelaer.info/tutorials/sphinx/rest_syntax.html)
`conf.py` is the configuration source for the Sphinx project
If any css or table of contents organization changes, run: `make clean html`
To activate a live-reload environment on `localhost:8000`, run: `sphinx-autobuild source build/html`