zephyr/doc
Peter Mitsis e5d9c58301 unified: Tweak pipe API parameters
- Reorders parameters where necessary
 - Adds alignment parameter to K_PIPE_DEFINE()
 - Renames parameters where necessary so they are sync'd
   between header and source files

Change-Id: I4f2367abc28aff646cc90beb9f08bb266e143b0c
Signed-off-by: Peter Mitsis <peter.mitsis@windriver.com>
2016-10-15 07:09:58 +00:00
..
api ztest: Add documentation 2016-09-30 21:17:40 +00:00
application doc: Remove contributor documentation moved to wiki 2016-08-04 22:01:10 +00:00
bluetooth
board boards: Rename the nRF52 Nitrogen to 96Boards Nitrogen 2016-09-30 17:13:39 +00:00
contribute doc: Remove contributor documentation moved to wiki 2016-08-04 22:01:10 +00:00
crypto doc: Terminology--Replace 'platform' with 'board' 2016-08-12 22:57:24 +00:00
drivers docs: Adjust driver documentation to show const config_info example. 2016-10-07 08:05:50 -04:00
getting_started win-doc: Adds the dependency with the pthread library 2016-09-30 17:49:41 +00:00
introduction doc: Relocate and revise "System Fundamentals" material 2016-07-08 19:39:10 +00:00
kernel doc: Terminology--Replace 'platform' with 'board' 2016-08-12 22:57:24 +00:00
kernel_v2 unified: Tweak pipe API parameters 2016-10-15 07:09:58 +00:00
porting x86: interrupts: optimize and simplify IRQ stubs 2016-09-28 20:28:06 +00:00
reference doc: Terminology--Replace 'platform' with 'board' 2016-08-12 22:57:24 +00:00
scripts/genrest doc: fix title generation for config options pages 2016-09-20 20:30:18 +00:00
subsystems doc: Update the device power management API documentation 2016-09-30 11:04:41 +00:00
themes/zephyr
Makefile doc: makefile doesn't print unneeded output of `pwd` 2016-08-02 06:47:21 +00:00
README.rst doc: remove warning "file not included in toctree" 2016-06-14 20:00:46 +00:00
conf.py doc: Merge substitutions into conf.py:rst_epilog 2016-06-15 01:44:52 +00:00
doxygen.config ztest: Add documentation 2016-09-30 21:17:40 +00:00
index.rst unified/doc: Kernel primer for unified kernel 2016-10-05 14:54:47 +00:00

README.rst

:orphan:

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