This document is viewable here:
http://theta360.guide/plugin-guide/
You can also view the MarkDown docs directly on GitHub in a web browser. The images and formatting will be automatically displayed by GitHub.
As of April 30, 2018, this guide is partially updated for the new API and SDK
- install MkDocs
- install material theme
pip install mkdocs-material
Create HTML from MarkDown
$ mkdocs build
Edit the *.md
files in ./docs/
only. Do not edit the HTML files in ./site
. The HTML files will be
overwritten by mkdocs build
.
Workflow to edit docs and view from local server
$ mkdocs serve
We are using a modified Material Design theme. Another theme can be specified
in mkdocs.yml
.