mirror of
https://github.com/Start9Labs/documentation.git
synced 2026-03-26 02:11:55 +00:00
1985952f87134910f625ba1745858796b0a029b0
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
Description
User manual, developer documentation, and support for the Start9 Labs' Embassy devices, EmbassyOS, and associated services
Readme
256 MiB
Languages
Python
54.3%
Makefile
22.8%
Shell
14.7%
HTML
4.9%
JavaScript
3.3%