From 50512893055923f7df6624a489c8fc2efd69550c Mon Sep 17 00:00:00 2001 From: Lucy Cifferello Date: Tue, 6 Oct 2020 20:42:15 -0600 Subject: [PATCH] update readme --- README.md | 24 ++++++++++++++++++------ 1 file changed, 18 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index ac9fd4b..7615797 100644 --- a/README.md +++ b/README.md @@ -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 \ No newline at end of file +## 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` \ No newline at end of file