zephyr

History

Allan Stephens ed78a03da2 doc: Enhance information about microkernel mailboxes Completely overhauls Kernel Primer section on mailboxes to fill in a host of omissions, correct errors, and improve readability. Change-Id: I7f27230f59a593f6b7f44f399363ba423156b43e Signed-off-by: Allan Stephens <allan.stephens@windriver.com>		2016-02-05 20:25:03 -05:00
..
application	qemu: Creation of QEMU specific platforms	2016-02-05 20:24:56 -05:00
collaboration	replace nano_tick_get_32 with sys_tick_get_32	2016-02-05 20:24:55 -05:00
crypto	DOC: edit the encryption documentation.	2016-02-05 20:24:21 -05:00
kernel	doc: Enhance information about microkernel mailboxes	2016-02-05 20:25:03 -05:00
platform	doc: codename -> Zephyr Kernel	2016-02-05 20:24:34 -05:00
quick_start	qemu: Creation of QEMU specific platforms	2016-02-05 20:24:56 -05:00
reference	Add group definition to event logger.	2016-02-05 20:24:41 -05:00
scripts/genrest	doc: Update Kconfig documentation tool 'genrest'	2016-02-05 20:24:54 -05:00
themes/zephyr	doc: Change conf.py and index.rst to fix the copyright and license.	2016-02-05 20:24:34 -05:00
Makefile	generate kconfig variables automatically	2016-02-05 20:15:35 -05:00
README.rst	doc: project -> Zephyr Project	2016-02-05 20:24:34 -05:00
about_zephyr.rst	doc: Fix warnings shown when building the documentation.	2016-02-05 20:24:36 -05:00
conf.py	Zephyr 0.6.0	2016-02-05 20:24:37 -05:00
doxygen.config	Add group definition to event logger.	2016-02-05 20:24:41 -05:00
index.rst	doc: Change conf.py and index.rst to fix the copyright and license.	2016-02-05 20:24:34 -05:00
substitutions.rst	doc: remove PM keyword from substitutions	2016-02-05 20:24:34 -05:00

README.rst

Welcome to Zephyr Kernel
########################

.. 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 Zephyr Project.

Thank you for your interest in the Zephyr Project. These instructions are
designed to walk you through generating the Zephyr 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 Zephyr 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.