2015-05-15 18:38:34 +02:00
|
|
|
..
|
2015-06-13 21:51:09 +02:00
|
|
|
Zephyr Project documentation master file
|
2015-05-15 18:38:34 +02:00
|
|
|
|
2016-02-05 17:06:00 +01:00
|
|
|
Zephyr Project Documentation
|
|
|
|
############################
|
|
|
|
|
2016-04-21 17:23:57 +02:00
|
|
|
.. only:: release
|
|
|
|
|
|
|
|
Welcome to the Zephyr Project's documentation version |version|!
|
|
|
|
|
|
|
|
Documentation for the development branch of Zephyr can be found at
|
2018-09-10 21:26:06 +02:00
|
|
|
https://docs.zephyrproject.org/
|
2016-04-21 17:23:57 +02:00
|
|
|
|
2017-01-04 15:39:45 +01:00
|
|
|
.. only:: (development or daily)
|
2016-04-21 17:23:57 +02:00
|
|
|
|
|
|
|
Welcome to the Zephyr Project's documentation. This is the documentation of the
|
2016-12-23 18:25:06 +01:00
|
|
|
master tree under development (version |version|).
|
2016-04-21 17:23:57 +02:00
|
|
|
|
2018-05-02 23:25:15 +02:00
|
|
|
Documentation for tagged released versions of Zephyr can be found at
|
2018-09-10 21:26:06 +02:00
|
|
|
``https://docs.zephyrproject.org/<version>``. The following documentation
|
2016-06-30 17:45:21 +02:00
|
|
|
versions are available:
|
2016-04-21 17:23:57 +02:00
|
|
|
|
2018-09-07 02:51:52 +02:00
|
|
|
`Zephyr 1.9.2`_ | `Zephyr 1.10.0`_ | `Zephyr 1.11.0`_ |
|
|
|
|
`Zephyr 1.12.0`_ | `Zephyr 1.13.0`_
|
2016-04-15 18:14:55 +02:00
|
|
|
|
2017-12-05 19:49:31 +01:00
|
|
|
For information about the changes and additions for releases, please
|
|
|
|
consult the published :ref:`zephyr_release_notes` documentation.
|
2017-08-18 05:10:16 +02:00
|
|
|
|
2017-08-21 22:46:43 +02:00
|
|
|
The Zephyr OS is provided under the `Apache 2.0 license`_ (as found in
|
|
|
|
the LICENSE file in the project's `GitHub repo`_). The Zephyr OS also
|
|
|
|
imports or reuses packages, scripts, and other files that use other
|
|
|
|
licensing, as described in :ref:`Zephyr_Licensing`.
|
2017-08-18 05:10:16 +02:00
|
|
|
|
2017-08-21 22:46:43 +02:00
|
|
|
Source code for the Zephyr Project is maintained in the Zephyr Project's
|
|
|
|
`GitHub repo`_.
|
|
|
|
|
|
|
|
.. _Apache 2.0 license:
|
|
|
|
https://github.com/zephyrproject-rtos/zephyr/blob/master/LICENSE
|
|
|
|
|
|
|
|
.. _GitHub repo: https://github.com/zephyrproject-rtos/zephyr
|
2017-08-03 16:15:58 +02:00
|
|
|
|
|
|
|
|
2018-08-23 20:11:11 +02:00
|
|
|
.. only:: html
|
|
|
|
|
|
|
|
Sections
|
|
|
|
********
|
2015-08-17 23:04:22 +02:00
|
|
|
|
2015-05-13 20:05:30 +02:00
|
|
|
.. toctree::
|
2015-08-29 15:14:50 +02:00
|
|
|
:maxdepth: 1
|
2015-05-13 20:05:30 +02:00
|
|
|
|
2017-01-14 04:25:09 +01:00
|
|
|
introduction/introducing_zephyr.rst
|
|
|
|
getting_started/getting_started.rst
|
2019-01-05 16:23:34 +01:00
|
|
|
contribute/index.rst
|
2019-01-08 16:29:13 +01:00
|
|
|
development_process/index.rst
|
2019-01-05 16:23:34 +01:00
|
|
|
application/application.rst
|
2018-10-12 22:55:02 +02:00
|
|
|
kernel/kernel.rst
|
|
|
|
security/security.rst
|
2019-01-05 16:23:34 +01:00
|
|
|
subsystems/subsystems.rst
|
|
|
|
devices/index.rst
|
|
|
|
tools/index.rst
|
|
|
|
porting/index.rst
|
2019-01-06 04:31:00 +01:00
|
|
|
documentation/index.rst
|
2019-01-05 16:23:34 +01:00
|
|
|
samples/samples.rst
|
|
|
|
api/index.rst
|
|
|
|
boards/boards.rst
|
|
|
|
reference/index.rst
|
2016-04-15 18:14:55 +02:00
|
|
|
|
2018-08-23 20:11:11 +02:00
|
|
|
.. only:: html
|
|
|
|
|
|
|
|
Indices and Tables
|
|
|
|
******************
|
2015-05-13 20:05:30 +02:00
|
|
|
|
2017-08-18 04:46:19 +02:00
|
|
|
* :ref:`glossary`
|
2015-05-13 20:05:30 +02:00
|
|
|
|
2017-08-18 04:46:19 +02:00
|
|
|
* :ref:`genindex`
|
2016-04-15 18:14:55 +02:00
|
|
|
|
2018-09-10 21:26:06 +02:00
|
|
|
.. _Zephyr 1.13.0: https://docs.zephyrproject.org/1.13.0/
|
|
|
|
.. _Zephyr 1.12.0: https://docs.zephyrproject.org/1.12.0/
|
|
|
|
.. _Zephyr 1.11.0: https://docs.zephyrproject.org/1.11.0/
|
|
|
|
.. _Zephyr 1.10.0: https://docs.zephyrproject.org/1.10.0/
|
|
|
|
.. _Zephyr 1.9.2: https://docs.zephyrproject.org/1.9.0/
|