mirror of
https://github.com/zephyrproject-rtos/zephyr
synced 2025-08-23 09:16:57 +00:00
31a3f6a70e
Event is such an overloaded and generic term (event logger, *kernel* event logger, "protocol" events in other subsystems, etc.), that it is confusing for the name an object. Events are kinda like signals, but not exactly, so we chose not to name them 'signals' to prevent further confusion. "Alerts" felt like a good fit, since they are used to "alert" an application that something of significance should be addressed and because an "alert handler" can be proactively registered with an alert. Change-Id: Ibfeb5eaf0e6e62702ac3fec281d17f8a63145fa1 Signed-off-by: Benjamin Walsh <benjamin.walsh@windriver.com> |
||
|---|---|---|
| .. | ||
| api | ||
| application | ||
| bluetooth | ||
| board | ||
| contribute | ||
| crypto | ||
| drivers | ||
| getting_started | ||
| introduction | ||
| kernel | ||
| kernel_v2 | ||
| porting | ||
| reference | ||
| scripts/genrest | ||
| subsystems | ||
| themes/zephyr | ||
| conf.py | ||
| doxygen.config | ||
| index.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