Changes between Initial Version and Version 1 of Docs/Build

Timestamp:

01/18/16 00:40:49 (8 years ago)

Author:

Amar Takhar

Comment:

Add a simple page on building the docs.

Docs/Build

@@ +1 @@
+= Build Documentation =
+
+[[TOC(Docs/Build , depth=2)]]
+
+This page explains how to build the documentation from source.
+
+You will need:
+
+  * [https://www.waf.io/ waf] - The waf build system.
+  * [http://www.sphinx-doc.org/ Sphinx] - The Sphinx documentation system.
+
+== Sphinx ==
+
+Most UNIX distributions have a package for Sphinx.  For manual installation refer to the [http://www.sphinx-doc.org/en/stable/install.html Install Page] on the Sphinx website.
+
+Windows users can find detailed instructions on the [http://www.sphinx-doc.org/en/stable/install.html#windows-install-python-and-sphinx Sphinx Website].
+
+== Building ==
+
+Each document can be built on its own by entering the directory and typing:
+
+{{{
+  # waf configure
+  # waf build
+}}}
+
+There is a general `book` document that will include '''all''' documentation available into one giant book.
+
+== Getting Source ==
+
+The source is located at:
+
+  * https://git.rtems.org/rtems-docs.git