summaryrefslogtreecommitdiffstats
path: root/docs
Commit message (Collapse)AuthorAgeFilesLines
* docs: Remove incompatible table formatPaul Barker2017-05-261-10/+11
| | | | | | | Sadly sphinx doesn't support pipe tables in markdown at the minute. Let's use a bullet-point list instead. Signed-off-by: Paul Barker <pbarker@toganlabs.com>
* docs: Include readme in sphinx documentationPaul Barker2017-05-262-0/+2
| | | | | | | 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-263-0/+593
| | | | | | | | | | 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>
* docs: Initial split of README into docs directoryPaul Barker2017-05-264-0/+251
The top-level README document has got pretty unwieldy and so we need to switch to add some more structure to our documentation. The first step is to split out sub-sections of the README document into separate files in a new 'docs' directory. Whilst splitting up the README, we can also take the opportunity to tidy things up and fix a couple of typos. Signed-off-by: Paul Barker <pbarker@toganlabs.com>