summaryrefslogtreecommitdiffstats
path: root/docs/index.rst
Commit message (Collapse)AuthorAgeFilesLines
* docs: Include readme in sphinx documentationPaul Barker2017-05-261-0/+1
| | | | | | | This allows us to avoid having to duplicate any information in the readme into another documentation file. Signed-off-by: Paul Barker <pbarker@toganlabs.com>
* docs: Initial sphinx configurationPaul Barker2017-05-261-0/+25
This allows us to create documentation by running 'make html' or 'make latexpdf' in the docs directory. It depends on sphinx and the recommonmark python module (for parsing markdown files in sphinx). Creation of the PDF document requires a full LaTeX toolchain to be installed. Signed-off-by: Paul Barker <pbarker@toganlabs.com>