3 Commits

Author	SHA1	Message	Date
Paul Barker	bf02bfd2ed	docs: Include readme in sphinx documentation ... 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>	2017-05-26 12:16:52 +01:00
Paul Barker	654d84d68a	docs: Initial sphinx configuration ... 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>	2017-05-26 12:16:52 +01:00
Paul Barker	03976f7ff1	docs: Initial split of README into docs directory ... 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>	2017-05-26 12:16:52 +01:00