documentation/README.md

Start9 Labs Documentation

Environment Setup

Install python3

Install sphinx: brew install sphinx-doc

Python dependencies:

pip3 install sphinx-autobuild
pip3 install sphinx-book-theme

To Develop

This project uses Sphinx and Restructured Text

./source/conf.py is the configuration source for the Sphinx project.

The navigation structure is aligned with the folder/file organization under ./source/. This is where the individual page .rst files live and can be edited.

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