zephyr

History

Rodrigo Caballero 8f1e55044b doc: Fix headings of the API documentation. Removes the Auto-generated text from the main heading. Changes the headings to the consistent hierarchy used elsewhere in the documentation. Change-Id: I146e4d7ac280b4a3bb81fc3263f826637a8bf08f Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com> Signed-off-by: Anas Nashif <anas.nashif@intel.com>		2016-02-05 20:24:36 -05:00
..
application	doc: Fix warnings shown when building the documentation.	2016-02-05 20:24:36 -05:00
collaboration	doc: Fix warnings shown when building the documentation.	2016-02-05 20:24:36 -05:00
crypto	DOC: edit the encryption documentation.	2016-02-05 20:24:21 -05:00
kernel	doc: Edits to the Overview and kernel primer	2016-02-05 20:24:36 -05:00
platform	doc: codename -> Zephyr Kernel	2016-02-05 20:24:34 -05:00
quick_start	doc: quick start: installing: add missing package required in fedora	2016-02-05 20:24:35 -05:00
reference	doc: Fix headings of the API documentation.	2016-02-05 20:24:36 -05:00
scripts/genrest	doc: fixed inclusion of files to avoid warnings	2016-02-05 20:24:34 -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	doc: Change conf.py and index.rst to fix the copyright and license.	2016-02-05 20:24:34 -05:00
doxygen.config	doxygen: remove obsolete config options	2016-02-05 20:24:23 -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.