mirror of
https://github.com/zephyrproject-rtos/zephyr
synced 2025-09-02 03:22:30 +00:00
572e052379
This will ensure uniformity in the future, but will require what code is currently aligned on 4-char tabs to be reformated (basically the kernel and arch code, and some other) to fit in 80 columns with 8-char tabs. However, it will be more natural to developers used to 8-char tabs, i.e. people used to work on Linux and other open source projects, which is our audience, and will lower the barrier of entry. Change-Id: I626b20e62ba1a5dddd030a27185f51237e5e98b5 Signed-off-by: Benjamin Walsh <benjamin.walsh@windriver.com> |
||
|---|---|---|
| .. | ||
| api | ||
| application | ||
| bluetooth | ||
| board | ||
| collaboration | ||
| crypto | ||
| getting_started | ||
| kernel | ||
| 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. 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