doc: Start writing some in-tree documentation
[petitboot] / doc / index.rst
1 .. Petitboot documentation master file, created by
2    sphinx-quickstart on Fri May 31 11:49:47 2019.
3    You can adapt this file completely to your liking, but it should at least
4    contain the root `toctree` directive.
5
6 Petitboot Documentation
7 =====================================
8
9 Overview
10 ========
11
12 .. toctree::
13    :maxdepth: 2
14
15    overview
16    components
17    platforms
18
19 Development
20 ===========
21
22 .. toctree::
23    :maxdepth: 1
24
25    dev/design
26    dev/submitting
27    dev/linux-image
28
29 Functionality
30 =============
31
32 .. toctree::
33    :maxdepth: 1
34
35    func/parsers
36    func/user_interface
37    func/autoboot
38    func/snapshots
39    func/ipmi
40    func/plugins
41
42 .. toctree::
43    :maxdepth: 2
44
45
46 .. only:: latex
47
48    Indices and tables
49    ==================
50
51    * :ref:`genindex`
52    * :ref:`modindex`
53    * :ref:`search`