patrick/zephyr
1
0
Fork 0
Code Issues Pull requests Actions 8 Packages Projects Releases Wiki Activity
zephyr/doc
History
Rodrigo Caballero 08ff46718c ADD Collaboration Guideline ReST content files. 
Includes the Collaboration Guideline. It contains the infromation
regarding the use of the mailing list, Gerrit, the coding style and
other usefull collaboration information.

This Collaboration Guideline is constantly changing as new methods of
collaboration are used.


Change-Id: I9f1e66556e99defa8729f87f19052b539e8628d3
Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
2016-02-05 20:14:01 -05:00
..
collaboration ADD Collaboration Guideline ReST content files. 2016-02-05 20:14:01 -05:00
doxygen ADD in-code documentation integration files. 2016-02-05 20:14:00 -05:00
installation ADD Installation Guide ReST content files. 2016-02-05 20:14:01 -05:00
conf.py CHANGE Doxygen configuration to limit it to the doc folder. 2016-02-05 20:14:00 -05:00
documentation_license.rst ADD framework files for ReST content. 2016-02-05 20:14:00 -05:00
doxygen.config CHANGE Doxygen configuration to limit it to the doc folder. 2016-02-05 20:14:00 -05:00
index.rst ADD framework files for ReST content. 2016-02-05 20:14:00 -05:00
Makefile Add tools and Makefiles for Documentation 2016-02-05 20:13:58 -05:00
README.rst ADD framework files for ReST content. 2016-02-05 20:14:00 -05:00
substitutions.rst ADD framework files for ReST content. 2016-02-05 20:14:00 -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 |project|.

Thank you for your interest in |project|. Read the instructions
carefully to generate the |project|'s documentation.


Documentation Notes
*******************

The documentation of |project| currently comprises the following items:

* An Installation Guide for Linux host systems

* A set of Collaboration Guidelines for the |project| 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:: $ export http_proxy=http://PROXY:PORT $ export
   https_proxy=http://PROXY:PORT

   $ git clone https://github.com/sphinx-doc/sphinx.git sphinx

   $ cd sphinx

   $ sudo -E python setup.py install

   $ 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 patches 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.