MARO Documentation

Pre-install

pip install -U -r requirements.docs.txt

Build docs

# For linux, darwin
make html

# For windows
./make.bat html

Local host

python -m http.server -d ./_build/html 8000 -b 0.0.0.0

Auto-build/Auto-refresh

Prerequisites

• Watchdog
• Browser-sync

# Watch file change, auto-build
watchmedo shell-command --patterns="*.rst;*.md;*.py;*.png;*.ico;*.svg" --ignore-pattern="_build/*" --recursive --command="APIDOC_GEN=False make html"
# Watch file change, auto-refresh
browser-sync start --server --startPath ./_build/html --port 8000 --files "**/*"