zephyrproject-rtos/zephyr
0
0
Fork 0
mirror of https://github.com/zephyrproject-rtos/zephyr synced 2025-09-02 04:46:29 +00:00
Code Issues Packages Projects Releases Wiki Activity
b33e59dc02
zephyr/doc
History
Allan Stephens bf684a10ba unified/doc: Update timing section of Kernel Primer 
Revises documentation for the kernel clocks to align it
with the actual behavior of the unified kernel.

Revises documentation for the kernel timer object type
to provide users with a more compact and intuitive API
that supports (directly or indirectly) the capabilities
of the now defunct microkernel timer and nanokernel
timer object types.

Note: A separate commit will be used to implement the
revised timer API described here.

Change-Id: Ifa4306c76e1c3e2aab1c0b55031df4179ac2a6b9
Signed-off-by: Allan Stephens <allan.stephens@windriver.com>
2016-10-19 18:14:58 +00:00
..
api ztest: Add documentation 2016-09-30 21:17:40 +00:00
application
bluetooth
board boards: Rename the nRF52 Nitrogen to 96Boards Nitrogen 2016-09-30 17:13:39 +00:00
contribute
crypto
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
kernel
kernel_v2 unified/doc: Update timing section of Kernel Primer 2016-10-19 18:14:58 +00:00
porting x86: interrupts: optimize and simplify IRQ stubs 2016-09-28 20:28:06 +00:00
reference
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
conf.py
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
Makefile
README.rst

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