-
Notifications
You must be signed in to change notification settings - Fork 2
Documentation
Chris Elenbaas edited this page Apr 9, 2024
·
5 revisions
The documentation is generated using MkDocs.
mkdocs.yml # The configuration file.
docs/
_static/ # Images used in the docs
javascripts/ # JS configuration files for extensions.
reference/ # HTML reference.
index.md # The documentation homepage.
tutorial.md
how-to-guides.md
reference.md # Code references (auto-generated through 'scripts/gen_reference_page.py').
In order to build OpenSquirrel documentation, run the following command in the root directory:
mkdocs build
You can serve the documentation locally to see, e.g., what the changes will look like in the browser:
mkdocs serve
The docs are hosted on GitHub pages. To deploy the docs run:
mkdocs gh-deploy
We use the Google style guide for the docstring format.