Documentation

MkDocs

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

Style guide

We use the Google style guide for the docstring format.