mirror of
https://github.com/zephyrproject-rtos/zephyr
synced 2025-08-06 11:25:44 +00:00
8765fbaa5a
Renames the Kinetis SDK (ksdk) to the MCUXpresso SDK (mcux) to reflect the recent rebranding by NXP to include support for LPC and i.MX SoCs. Temporarily leaves the config option HAS_KSDK to allow renaming each shim driver in a separate commit. Change-Id: I738f3687755fcd429a105e723fa25f1da815b519 Signed-off-by: Maureen Helm <maureen.helm@nxp.com> |
||
|---|---|---|
| .. | ||
| api | ||
| application | ||
| contribute | ||
| crypto | ||
| drivers | ||
| getting_started | ||
| introduction | ||
| kernel | ||
| porting | ||
| reference/kconfig | ||
| scripts/genrest | ||
| subsystems | ||
| templates | ||
| themes/zephyr | ||
| conf.py | ||
| doxygen.config | ||
| LICENSING.rst | ||
| Makefile | ||
| README.rst | ||
| release-notes.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 To install ReadTheDocs.org theme, use pip to install the python package: .. code-block:: bash $ pip install sphinx_rtd_theme If the above theme is installed, it will be used instead of the default theme. .. 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 ``<ZEPHYR_BASE>``, type: .. code-block:: bash $ cd <ZEPHYR_BASE> $ make htmldocs Find the output in ``<ZEPHYR_BASE>/doc/_build/html/index.html`` Review the available formats with: .. code-block:: bash $ make -C <ZEPHYR_BASE>/doc help 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