zephyr

History

Rodrigo Caballero cfb5bdc202 Doc: Add license guidelines with the acceptable code licenses. The license guidelines list which code licenses are acceptable and what licenses can be problematic. It also includes the IANAL disclaimer. The collaboration.rst was changed to include the new content. Change-Id: I92081a13575453c68b2492129126be4b4cee9766 Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>		2016-02-05 20:14:33 -05:00
..
architecture	Doc: Edit the microkernel overview with additional information.	2016-02-05 20:14:32 -05:00
collaboration	Doc: Add license guidelines with the acceptable code licenses.	2016-02-05 20:14:33 -05:00
development	Rename Zephyr OS into Zephyr Kernel	2016-02-05 20:14:26 -05:00
documentation	Doc: Edit to the Doxygen guidelines based on feedback.	2016-02-05 20:14:32 -05:00
doxygen	Doc: Edit to the Doxygen guidelines based on feedback.	2016-02-05 20:14:32 -05:00
installation	Doc: Edits performed on the Quick Start Guide.	2016-02-05 20:14:32 -05:00
net	doc: Rename network secion name	2016-02-05 20:14:27 -05:00
object	doc: microkernel fix PIPE API descriptions	2016-02-05 20:14:28 -05:00
platform	Quark Platform Configuration documentation	2016-02-05 20:14:33 -05:00
themes/zephyr	doc: add custom zephyr theme	2016-02-05 20:14:28 -05:00
conf.py	doc: add custom zephyr theme	2016-02-05 20:14:28 -05:00
disclaimers.rst	Fix the index page and headers	2016-02-05 20:14:21 -05:00
documentation_license.rst	Fix the index page and headers	2016-02-05 20:14:21 -05:00
doxygen.config	Doc: Add Bluetooth basic documentation	2016-02-05 20:14:27 -05:00
index.rst	doc: Initial platform configuration guides	2016-02-05 20:14:33 -05:00
Makefile	Add tools and Makefiles for Documentation	2016-02-05 20:13:58 -05:00
README.rst	Adapt installation guide with current requirements	2016-02-05 20:14:16 -05:00
substitutions.rst	Rename Zephyr OS into Zephyr Kernel	2016-02-05 20:14:26 -05:00

README.rst

.. include:: substitutions.rst

Welcome to |codename|
#####################

.. This document is in Restructured Text Format.

   More information at `<http://sphinx-doc.org/rest.html>`_.
   This is a comment that won't show up in formatted output

Welcome to the |project|.

Thank you for your interest in the |project|. These instructions are
designed to walk you through generating the |project|'s documentation.


Documentation Notes
*******************

The project's documentation currently comprises the following items:

* An Installation Guide for Linux host systems

* A set of Collaboration Guidelines for the project.

* Raw Doxygen output from the code base.

Installing the documentation processors
***************************************

Install the current version of :program:`Sphinx`, type:

.. code-block:: bash

   $ git clone https://github.com/sphinx-doc/sphinx.git sphinx

   $ cd sphinx

   $ sudo -E python setup.py install

   $ cd ..

   $ git clone https://github.com/michaeljones/breathe.git breathe

   $ cd breathe

   $ sudo -E python setup.py install

.. note::

   Make sure that :program:`Doxygen` is installed in your system.
   The installation of Doxygen is beyond the scope of this document.

Running the documentation generators
************************************

Assuming that the |project| tree with the doc directory is in
:file:`DIRECTORY`, type:

.. code-block:: bash

   $ cd DIRECTORY/doc

   $ make doxy html

Find the output in :file:`DIRECTORY/doc/_build/html/index.html`

Review the available formats with:

.. code-block:: bash

   $ make -C DIRECTORY/doc doxy html

If you want the LaTeX PDF output, you need to install all the Latex
packages first. That installation is beyond the scope of this document.