summaryrefslogtreecommitdiffstats
path: root/Documentation/index.rst
diff options
context:
space:
mode:
authorSascha Hauer <s.hauer@pengutronix.de>2014-06-17 10:37:25 +0200
committerSascha Hauer <s.hauer@pengutronix.de>2014-06-26 11:07:10 +0200
commit3fef396bb42efc0bb12b0a8caf0d076ab1c4d879 (patch)
tree91625b2407ed25dffd093b19159135481eb80f84 /Documentation/index.rst
parent7e65163b9165bccca780da91fad247c0e4ac7f9f (diff)
downloadbarebox-3fef396bb42efc0bb12b0a8caf0d076ab1c4d879.tar.gz
barebox-3fef396bb42efc0bb12b0a8caf0d076ab1c4d879.tar.xz
Documentation: Add new sphinxs docs
This is a rewrite of the Documentation in reStructuredText format using Sphinx as build system, see http://sphinx-doc.org/. The documentation is built into static html pages with 'make docs'. The pages can be found under Documentation/html after building. Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
Diffstat (limited to 'Documentation/index.rst')
-rw-r--r--Documentation/index.rst26
1 files changed, 26 insertions, 0 deletions
diff --git a/Documentation/index.rst b/Documentation/index.rst
new file mode 100644
index 0000000000..aff450a3c3
--- /dev/null
+++ b/Documentation/index.rst
@@ -0,0 +1,26 @@
+.. barebox documentation master file, created by
+ sphinx-quickstart on Tue Jun 17 11:45:57 2014.
+ You can adapt this file completely to your liking, but it should at least
+ contain the root `toctree` directive.
+
+Welcome to barebox
+==================
+
+Contents:
+
+.. toctree::
+ :glob:
+ :numbered:
+ :maxdepth: 1
+
+ download
+ user/user-manual
+ filesystems
+ commands
+ boards
+ glossary
+ devicetree/*
+
+* :ref:`search`
+* :ref:`genindex`
+