zephyr

History

L.S. Cook 13d064c58c doc: Edited synchronous_call.rst for typos, ReST syntax API notes needed a bit of clarification, fixed typo of file name. Change-Id: I57438165fb2fc3da796fcde19d58a46862ffbbd9 Signed-off-by: L.S. Cook <leonax.cook@intel.com>		2016-02-25 21:32:06 +00:00
..
api	docs: fixed API linking	2016-02-16 06:16:48 +00:00
application	doc: fix path to samples after restructering	2016-02-11 13:08:44 -05:00
bluetooth	Bluetooth: doc: Add L2CAP PICS file	2016-02-16 13:50:00 +01:00
board	docs: arduino 101: remove zflash references	2016-02-25 21:28:58 +00:00
collaboration	docs: gerrit: descrease indentation and remove TOC	2016-02-25 21:28:58 +00:00
crypto	docs: fixed crypto headline and bullet indentation	2016-02-25 21:28:58 +00:00
getting_started	doc : getting_started : correct path	2016-02-23 23:10:57 +00:00
kernel	doc: Edited synchronous_call.rst for typos, ReST syntax	2016-02-25 21:32:06 +00:00
reference	doc: Remove orphaned kbuild_toolchains.rst	2016-02-18 22:58:07 +00:00
scripts/genrest	doc: add brief description for Kconfig in the reference	2016-02-09 18:04:36 +00:00
themes/zephyr	doc: Change conf.py and index.rst to fix the copyright and license.	2016-02-05 20:24:34 -05:00
about_zephyr.rst	trivial: fixed typo: sempahores -> semaphores	2016-02-09 18:04:36 +00:00
conf.py	Zephyr 0.6.0	2016-02-05 20:24:37 -05:00
doxygen.config	doc: Edit the Event Logger APIs	2016-02-12 01:41:20 +00:00
index.rst	doc: Fix headings in master index file.	2016-02-08 16:16:59 -05:00
Makefile	docs: fixed errors when building docs	2016-02-25 21:28:58 +00:00
README.rst	doc: Change link in README to external link.	2016-02-08 16:16:59 -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.
   Find more information regarding the ReST markup in the
   `ReST documentation`_.
   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.

* Doxygen output from the code base for all APIs.

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

Install the current version of ``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 ``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
``DIRECTORY``, type:

.. code-block:: bash

   $ cd DIRECTORY/doc

   $ make doxy html

Find the output in ``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.

.. _ReST documentation: http://sphinx-doc.org/rest.html