diff options
| author | Paul Barker <pbarker@toganlabs.com> | 2017-05-23 10:26:38 +0100 |
|---|---|---|
| committer | Andrei Gherzan <andrei@gherzan.com> | 2017-05-26 12:16:52 +0100 |
| commit | 654d84d68a65318909d19a28c05d8172f6337972 (patch) | |
| tree | 973d492544304ed234fe54e9cbba25c516d5b73f /docs/index.rst | |
| parent | 03976f7ff12885d1205effe526c83b10ed4252fe (diff) | |
| download | meta-raspberrypi-654d84d68a65318909d19a28c05d8172f6337972.tar.gz | |
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>
Diffstat (limited to 'docs/index.rst')
| -rw-r--r-- | docs/index.rst | 25 |
1 files changed, 25 insertions, 0 deletions
diff --git a/docs/index.rst b/docs/index.rst new file mode 100644 index 0000000..bb1ae3d --- /dev/null +++ b/docs/index.rst | |||
| @@ -0,0 +1,25 @@ | |||
| 1 | .. meta-raspberrypi documentation master file, created by | ||
| 2 | sphinx-quickstart on Tue May 23 09:51:24 2017. | ||
| 3 | You can adapt this file completely to your liking, but it should at least | ||
| 4 | contain the root `toctree` directive. | ||
| 5 | |||
| 6 | Welcome to meta-raspberrypi's documentation! | ||
| 7 | ============================================ | ||
| 8 | |||
| 9 | Contents: | ||
| 10 | |||
| 11 | .. toctree:: | ||
| 12 | :maxdepth: 2 | ||
| 13 | |||
| 14 | layer-contents | ||
| 15 | extra-build-config | ||
| 16 | extra-apps | ||
| 17 | contributing | ||
| 18 | |||
| 19 | Indices and tables | ||
| 20 | ================== | ||
| 21 | |||
| 22 | * :ref:`genindex` | ||
| 23 | * :ref:`modindex` | ||
| 24 | * :ref:`search` | ||
| 25 | |||
