OrgZephyr/zephyr
OrgZephyr
/
zephyr
mirror of https://github.com/zephyrproject-rtos/zephyr.git
1
0
Fork 0
Code Issues Releases Wiki Activity
zephyr/doc
History
L.S. Cook d229efe476 doc: cleaning up tone to be a little more polite to potential feedback givers 
Gerrit review improvements

Signed-off-by: Leona Cook <leonax.cook@intel.com>
Change-Id: I39d00195c47ac015246068b308ef69e0ecb2d024
 		2016-02-05 20:24:28 -05:00
..
application doc: edited grammar, punctuation, spelling, word usage. 2016-02-05 20:15:36 -05:00
collaboration doc: cleaning up tone to be a little more polite to potential feedback givers 2016-02-05 20:24:28 -05:00
crypto DOC: edit the encryption documentation. 2016-02-05 20:24:21 -05:00
kernel doc: Add documentation for sys_thread_busy_wait() 2016-02-05 20:24:28 -05:00
platform kconfig: use zephyr as the binary name globally 2016-02-05 20:24:22 -05:00
quick_start doc: use zephyr for SDK, not yocto 2016-02-05 20:24:23 -05:00
reference doc: use zephyr for SDK, not yocto 2016-02-05 20:24:23 -05:00
scripts/genrest generate kconfig variables automatically 2016-02-05 20:15:35 -05:00
themes/zephyr doc: add custom zephyr theme 2016-02-05 20:14:28 -05:00
Makefile generate kconfig variables automatically 2016-02-05 20:15:35 -05:00
README.rst doc: remove duplicate include of substitutions.rst 2016-02-05 20:15:34 -05:00
about_zephyr.rst doc: fixed type sempahores -> semaphores 2016-02-05 20:24:17 -05:00
conf.py doc: set copyright on every page 2016-02-05 20:24:23 -05:00
disclaimers.rst Doc: Restructure clean up. 2016-02-05 20:15:33 -05:00
documentation_license.rst doc: set copyright on every page 2016-02-05 20:24:23 -05:00
doxygen.config doxygen: remove obsolete config options 2016-02-05 20:24:23 -05:00
index.rst doc: set copyright on every page 2016-02-05 20:24:23 -05:00
substitutions.rst Rename Zephyr OS into Zephyr Kernel 2016-02-05 20:14:26 -05:00

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