mirror of
https://github.com/zephyrproject-rtos/zephyr
synced 2025-08-25 12:15:23 +00:00
6b07c1d548
Standardizes appearance, corrects errors, improves readability, and fils in gaps. Also relocates documentation for internal APIs. Removes mention of non-existent task_sem_group_take() API from the Kernel Primer document. The microkernel's semaphore group logic currently allows a task to take a semaphore from a semaphore group in a blocking manner. Change-Id: Ib41a43775a97483a5adc552b70575ae4269aba35 Signed-off-by: Allan Stephens <allan.stephens@windriver.com> |
||
|---|---|---|
| .. | ||
| application | ||
| collaboration | ||
| crypto | ||
| kernel | ||
| platform | ||
| quick_start | ||
| reference | ||
| scripts/genrest | ||
| themes/zephyr | ||
| about_zephyr.rst | ||
| conf.py | ||
| 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.