mirror of
https://github.com/zephyrproject-rtos/zephyr
synced 2025-09-04 05:51:56 +00:00
d743ae6c92
We do not support xtools, although it can be used, it should not be documented as an alternative. Change-Id: I7be753393e4976b8c9610bdb33f1018dfef5eb95 Signed-off-by: Anas Nashif <anas.nashif@intel.com> |
||
|---|---|---|
| .. | ||
| application | ||
| collaboration | ||
| crypto | ||
| kernel | ||
| platform | ||
| quick_start | ||
| reference | ||
| scripts/genrest | ||
| themes/zephyr | ||
| about_zephyr.rst | ||
| conf.py | ||
| documentation_license.rst | ||
| doxygen.config | ||
| index.rst | ||
| Makefile | ||
| README.rst | ||
| substitutions.rst | ||
Welcome to Zephyr Kernel ######################## .. 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 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. * 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 Zephyr 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.