Kai Mei 7453703daf docs: update installer and docs (#271) 1 周之前
..
assets 633dccd793 add constrains on the step execution and workflow generation (#250) 3 周之前
source 7453703daf docs: update installer and docs (#271) 1 周之前
.readthedocs.yaml 979c219741 update docs (#258) 3 周之前
Makefile 6c7d1f5fa0 docs: add website doc template using readthedocs (#162) 3 月之前
README.md 979c219741 update docs (#258) 3 周之前
make.bat 6c7d1f5fa0 docs: add website doc template using readthedocs (#162) 3 月之前
requirements-doc.txt cebaf3927c docs: add guide of installation and usage (#165) 3 月之前

README.md

AIOS documentation

Build the docs

# Install dependencies.
pip install -r requirements-docs.txt

# Build the docs.
make clean
make html

Open the docs with your browser

python -m http.server -d build/html/

Launch your browser and open localhost:8000.

Guides of how to write the docs

We use the readthedocs to build documentation, the guideline is here. The theme we used is spinx-book.