Documentation

• user documentation is written in reStructuredText format

• sme Python API documentation is generated from the Google style Docstrings

• core C++ documentation is generated from the Doxygen documentation

• documentation should be updated along with source code changes in pull requests

Read the Docs

• on each commit, docs are automatically compiled and uploaded to readthedocs

• note: sme API documentation is generated by readthedocs from the latest pre-release sme module

• open pull request docs are also compiled and can be previewed on readthedocs

Animated screenshots

• the quickstart guide contains animated screenshots in apng format

• peek.sh is a simple script to help record these using peek (on linux)