mirror of
https://github.com/zephyrproject-rtos/zephyr
synced 2025-09-02 04:46:29 +00:00
dbe30711fd
The Zephyr kernel tree has imported or reuses packages, scripts that are not covered by the Apache LICENSE. As in some places it is not clear (there is no LICENSE file or way to put it there), here we list them to ensure there is proper license acknowledgement. This is an initial proposal--I welcome feedback on everything, especially where to link the documentation (kind of kludgy now) and more missed components from this initial list. v5: Added David Kinder's feedback v4: Fixed more typos in Makefile v3: fixed some more typos, but still holding on to feedback on how it can be done with SPDX files, as it is not yet all clear to me. Jira: ZEP-1079 Change-Id: Ie1bf545e26b0d304cd3ea0d70cdfc13d520197fe Signed-off-by: Inaky Perez-Gonzalez <inaky.perez-gonzalez@intel.com> |
||
|---|---|---|
| .. | ||
| api | ||
| application | ||
| board | ||
| contribute | ||
| crypto | ||
| drivers | ||
| getting_started | ||
| introduction | ||
| kernel_v2 | ||
| porting | ||
| reference | ||
| scripts/genrest | ||
| subsystems | ||
| themes/zephyr | ||
| conf.py | ||
| doxygen.config | ||
| index.rst | ||
| LICENSING.rst | ||
| Makefile | ||
| README.rst | ||
:orphan: Welcome to Zephyr Kernel ######################## .. This document is in Restructured Text Format. Find more information regarding the ReST markup in the `ReST documentation`_. 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. * Doxygen output from the code base for all APIs. Installing the documentation processors *************************************** Install the current version of ``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 ``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 ``DIRECTORY``, type: .. code-block:: bash $ cd DIRECTORY/doc $ make doxy html Find the output in ``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. .. _ReST documentation: http://sphinx-doc.org/rest.html