zephyr

mirror of https://github.com/zephyrproject-rtos/zephyr synced 2025-08-11 06:46:04 +00:00

History

Carol Lee d12fcef665 doc: Add microkernel mutex object info Adds a description for the mutex object, which is currently undocumented. This text uses an enhanced structure that presents the material in a more user-friendly manner. Change-Id: I986be388b4943064d0449c2194de786fbad84863 Signed-off-by: Carol Lee <carol.lee@windriver.com>		2016-02-05 20:14:24 -05:00
..
collaboration	Tiny Mountain -> Zephyr renames	2016-02-05 20:14:21 -05:00
doxygen	Tiny Mountain -> Zephyr renames	2016-02-05 20:14:21 -05:00
installation	remove extra space from quick start	2016-02-05 20:14:21 -05:00
kbuild	Kbuild Documentation	2016-02-05 20:14:23 -05:00
object	doc: Add microkernel mutex object info	2016-02-05 20:14:24 -05:00
conf.py	Set version of documentation to 0.1	2016-02-05 20:14:21 -05:00
disclaimers.rst	Fix the index page and headers	2016-02-05 20:14:21 -05:00
documentation_license.rst	Fix the index page and headers	2016-02-05 20:14:21 -05:00
doxygen.config
index.rst	Fix the index page and headers	2016-02-05 20:14:21 -05:00
Makefile
README.rst
substitutions.rst	Tiny Mountain -> Zephyr renames	2016-02-05 20:14:21 -05:00

README.rst

.. include:: substitutions.rst

Welcome to |codename|
#####################

.. 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 |project|.

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