doc: Start writing some in-tree documentation

[petitboot] / doc / index.rst

diff --git a/doc/index.rst b/doc/index.rst
new file mode 100644 (file)
index 0000000..fe95699
--- /dev/null
+++ b/doc/index.rst
@@ -0,0 +1,53 @@
+.. Petitboot documentation master file, created by
+   sphinx-quickstart on Fri May 31 11:49:47 2019.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Petitboot Documentation
+=====================================
+
+Overview
+========
+
+.. toctree::
+   :maxdepth: 2
+
+   overview
+   components
+   platforms
+
+Development
+===========
+
+.. toctree::
+   :maxdepth: 1
+
+   dev/design
+   dev/submitting
+   dev/linux-image
+
+Functionality
+=============
+
+.. toctree::
+   :maxdepth: 1
+
+   func/parsers
+   func/user_interface
+   func/autoboot
+   func/snapshots
+   func/ipmi
+   func/plugins
+
+.. toctree::
+   :maxdepth: 2
+
+
+.. only:: latex
+
+   Indices and tables
+   ==================
+
+   * :ref:`genindex`
+   * :ref:`modindex`
+   * :ref:`search`