mirror of
https://github.com/zephyrproject-rtos/zephyr
synced 2025-08-06 13:45:22 +00:00
17fa692922
Includes an explanation of how the in-code documentation is integrated using Doxygen / Breathe and the raw generated output from the code. These files are needed to understand how the in-code comments flow into the documentation and to be able to display and link to those comments from the documentation. Change-Id: I275f8c32cfe889da43b4db5b8037e52876ae3c68 Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com> Signed-off-by: Anas Nashif <anas.nashif@intel.com> |
||
|---|---|---|
| .. | ||
| doxygen | ||
| conf.py | ||
| documentation_license.rst | ||
| doxygen.config | ||
| index.rst | ||
| Makefile | ||
| README.rst | ||
| substitutions.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.