User documentation
Description of change
Based on the wonderful work of @strangenoise.
Converted his work from markdown to reST
format and documentation building with Sphinx.
- User documentation written. Go to
docs/
and run eithermake html
on Unix or themake.bat
on Win. - Added a 'video' directive to optimize GIFs loading.
Closes #69 (closed)
How to test it
- Install sphinx:
pip install sphinx sphinx_rtd_theme
- Go to
docs/
and run eithermake html
on Unix or themake.bat
on Win. - Open the built
index.html
in a browser.
Checklist
Please check if your MR fulfills the following requirements:
-
Unit tests have been added, if needed -
Documentation have been updated, if needed -
Build was run locally and any changes were pushed -
Lint has passed locally without error -
Package.py have been updated, if needed -
CHANGELOG.md have been updated, if needed -
Version numer has been tagged, if needed
Edited by Félix David