doc: changed structure and layout
Move to the new structure with both: - API Reference - User and Developer Guides Signed-off-by: Anas Nashif <anas.nashif@intel.com>
This commit is contained in:
parent
4beba9f948
commit
4d93a9797f
13 changed files with 61 additions and 98 deletions
|
@ -1,21 +0,0 @@
|
||||||
.. _api:
|
|
||||||
|
|
||||||
APIs
|
|
||||||
####
|
|
||||||
|
|
||||||
This section contains the API documentation automatically extracted from the
|
|
||||||
code. If you are looking for a specific API, enter it on the search box.
|
|
||||||
The search results display all sections containing information
|
|
||||||
about that API.
|
|
||||||
|
|
||||||
The Zephyr APIs are used the same way on all SoCs and boards.
|
|
||||||
|
|
||||||
.. toctree::
|
|
||||||
:maxdepth: 2
|
|
||||||
|
|
||||||
bluetooth.rst
|
|
||||||
networking.rst
|
|
||||||
file_system
|
|
||||||
display_api
|
|
||||||
misc_api
|
|
||||||
peripherals/index.rst
|
|
|
@ -1,11 +0,0 @@
|
||||||
.. _devices:
|
|
||||||
|
|
||||||
Device and Driver Support
|
|
||||||
#########################
|
|
||||||
|
|
||||||
.. toctree::
|
|
||||||
:maxdepth: 2
|
|
||||||
|
|
||||||
drivers/drivers.rst
|
|
||||||
dts/device_tree.rst
|
|
||||||
dts/flash_partitions.rst
|
|
|
@ -1,10 +0,0 @@
|
||||||
.. documenting_zephyr:
|
|
||||||
|
|
||||||
Documentation Guidelines
|
|
||||||
########################
|
|
||||||
|
|
||||||
.. toctree::
|
|
||||||
:maxdepth: 1
|
|
||||||
|
|
||||||
../README.rst
|
|
||||||
doc-guidelines.rst
|
|
|
@ -65,11 +65,11 @@ licensing, as described in :ref:`Zephyr_Licensing`.
|
||||||
by Zephyr</p>
|
by Zephyr</p>
|
||||||
</li>
|
</li>
|
||||||
<li class="grid-item">
|
<li class="grid-item">
|
||||||
<a href="kernel/kernel.html">
|
<a href="reference.html">
|
||||||
<img alt="" src=""/>
|
<img alt="" src=""/>
|
||||||
<h2>Kernel Services</h2>
|
<h2>API Reference</h2>
|
||||||
</a>
|
</a>
|
||||||
<p>General introduction of the Zephyr kernel’s key capabilities and services.</p>
|
<p>API Documentation and Reference</p>
|
||||||
</li>
|
</li>
|
||||||
<li class="grid-item">
|
<li class="grid-item">
|
||||||
<a href="security/security.html">
|
<a href="security/security.html">
|
||||||
|
@ -86,11 +86,11 @@ licensing, as described in :ref:`Zephyr_Licensing`.
|
||||||
<p>List if supported boards and platforms.</p>
|
<p>List if supported boards and platforms.</p>
|
||||||
</li>
|
</li>
|
||||||
<li class="grid-item">
|
<li class="grid-item">
|
||||||
<a href="tools/index.html">
|
<a href="user_guides.html">
|
||||||
<img alt="" src=""/>
|
<img alt="" src=""/>
|
||||||
<h2>Tools</h2>
|
<h2>User and Developer Guides</h2>
|
||||||
</a>
|
</a>
|
||||||
<p>List of Tools used for development.</p>
|
<p>User and Developer Guides</p>
|
||||||
</li>
|
</li>
|
||||||
</ul>
|
</ul>
|
||||||
|
|
||||||
|
@ -107,17 +107,11 @@ licensing, as described in :ref:`Zephyr_Licensing`.
|
||||||
contribute/index.rst
|
contribute/index.rst
|
||||||
development_process/index.rst
|
development_process/index.rst
|
||||||
application/application.rst
|
application/application.rst
|
||||||
kernel/kernel.rst
|
reference.rst
|
||||||
|
user_guides.rst
|
||||||
security/security.rst
|
security/security.rst
|
||||||
subsystems/subsystems.rst
|
|
||||||
devices/index.rst
|
|
||||||
tools/index.rst
|
|
||||||
porting/index.rst
|
|
||||||
documentation/index.rst
|
|
||||||
samples/samples.rst
|
samples/samples.rst
|
||||||
api/index.rst
|
|
||||||
boards/boards.rst
|
boards/boards.rst
|
||||||
reference/index.rst
|
|
||||||
|
|
||||||
.. only:: html
|
.. only:: html
|
||||||
|
|
||||||
|
|
23
doc/reference.rst
Normal file
23
doc/reference.rst
Normal file
|
@ -0,0 +1,23 @@
|
||||||
|
.. _api_reference:
|
||||||
|
|
||||||
|
API Reference
|
||||||
|
#############
|
||||||
|
|
||||||
|
.. toctree::
|
||||||
|
:maxdepth: 1
|
||||||
|
|
||||||
|
api/bluetooth/index.rst
|
||||||
|
reference/kconfig/index.rst
|
||||||
|
devices/drivers/drivers.rst
|
||||||
|
api/display_api
|
||||||
|
api/file_system
|
||||||
|
kernel/kernel.rst
|
||||||
|
subsystems/logging/index
|
||||||
|
api/misc_api
|
||||||
|
api/networking.rst
|
||||||
|
api/peripherals/index.rst
|
||||||
|
subsystems/power_management.rst
|
||||||
|
subsystems/shell/shell
|
||||||
|
subsystems/storage.rst
|
||||||
|
subsystems/usb/usb.rst
|
||||||
|
|
|
@ -1,9 +0,0 @@
|
||||||
.. _reference:
|
|
||||||
|
|
||||||
Reference
|
|
||||||
##########
|
|
||||||
|
|
||||||
.. toctree::
|
|
||||||
:maxdepth: 1
|
|
||||||
|
|
||||||
kconfig/index.rst
|
|
|
@ -269,7 +269,7 @@ important submodules. For each of the modules, a dedicated architecture
|
||||||
document shall be created and evaluated against the implementation.
|
document shall be created and evaluated against the implementation.
|
||||||
These documents shall serve as an entry point to new developers and as a
|
These documents shall serve as an entry point to new developers and as a
|
||||||
basis for the security architecture. Please refer to the
|
basis for the security architecture. Please refer to the
|
||||||
:ref:`Zephyr Kernel subsystem documentation <subsystems>` for
|
:ref:`Zephyr subsystem documentation <api_reference>` for
|
||||||
detailed information.
|
detailed information.
|
||||||
|
|
||||||
Secure Coding Guidelines
|
Secure Coding Guidelines
|
||||||
|
|
|
@ -16,7 +16,7 @@ consists of two different modules:
|
||||||
The DFU subsystem deals with image management, but not with the transport
|
The DFU subsystem deals with image management, but not with the transport
|
||||||
or management protocols themselves required to send the image to the target
|
or management protocols themselves required to send the image to the target
|
||||||
device. For information on these protocols and frameworks please refer to the
|
device. For information on these protocols and frameworks please refer to the
|
||||||
:ref:`mgmt` section.
|
:ref:`device_mgmt` section.
|
||||||
|
|
||||||
Bootloaders
|
Bootloaders
|
||||||
***********
|
***********
|
||||||
|
|
|
@ -1,7 +1,7 @@
|
||||||
.. _mgmt:
|
.. _device_mgmt:
|
||||||
|
|
||||||
Management
|
Device Management
|
||||||
##########
|
#################
|
||||||
|
|
||||||
Overview
|
Overview
|
||||||
********
|
********
|
||||||
|
|
|
@ -1,23 +0,0 @@
|
||||||
.. _subsystems:
|
|
||||||
|
|
||||||
Subsystems
|
|
||||||
##########
|
|
||||||
|
|
||||||
This section contains information about subsystem and the API they expose
|
|
||||||
to applications.
|
|
||||||
|
|
||||||
.. toctree::
|
|
||||||
:maxdepth: 1
|
|
||||||
|
|
||||||
bluetooth/bluetooth.rst
|
|
||||||
c_library
|
|
||||||
dfu
|
|
||||||
logging/index
|
|
||||||
tracing/index
|
|
||||||
mgmt
|
|
||||||
networking/networking.rst
|
|
||||||
power_management.rst
|
|
||||||
shell/shell
|
|
||||||
test/index
|
|
||||||
usb/usb.rst
|
|
||||||
storage.rst
|
|
|
@ -6,8 +6,4 @@ Tools
|
||||||
.. toctree::
|
.. toctree::
|
||||||
:maxdepth: 1
|
:maxdepth: 1
|
||||||
|
|
||||||
kconfig/index.rst
|
|
||||||
kconfig/functions.rst
|
kconfig/functions.rst
|
||||||
west/index.rst
|
|
||||||
coccinelle.rst
|
|
||||||
code-relocation.rst
|
|
||||||
|
|
24
doc/user_guides.rst
Normal file
24
doc/user_guides.rst
Normal file
|
@ -0,0 +1,24 @@
|
||||||
|
.. _user_guides:
|
||||||
|
|
||||||
|
User and Developer Guides
|
||||||
|
#########################
|
||||||
|
|
||||||
|
.. toctree::
|
||||||
|
:maxdepth: 1
|
||||||
|
|
||||||
|
subsystems/bluetooth/index.rst
|
||||||
|
subsystems/c_library
|
||||||
|
README.rst
|
||||||
|
tools/coccinelle.rst
|
||||||
|
tools/code-relocation.rst
|
||||||
|
documentation/doc-guidelines.rst
|
||||||
|
devices/dts/device_tree.rst
|
||||||
|
devices/dts/flash_partitions.rst
|
||||||
|
subsystems/dfu
|
||||||
|
tools/kconfig/index.rst
|
||||||
|
subsystems/mgmt
|
||||||
|
networking/networking.rst
|
||||||
|
porting/index.rst
|
||||||
|
subsystems/test/index
|
||||||
|
subsystems/tracing/index
|
||||||
|
tools/west/index.rst
|
|
@ -8,7 +8,7 @@ Overview
|
||||||
|
|
||||||
This sample application implements a Simple Management Protocol (SMP) server.
|
This sample application implements a Simple Management Protocol (SMP) server.
|
||||||
SMP is a basic transfer encoding for use with the MCUmgr management protocol.
|
SMP is a basic transfer encoding for use with the MCUmgr management protocol.
|
||||||
For more information about MCUmgr and SMP, please see :ref:`mgmt`.
|
For more information about MCUmgr and SMP, please see :ref:`device_mgmt`.
|
||||||
|
|
||||||
This sample application supports the following mcumgr transports by default:
|
This sample application supports the following mcumgr transports by default:
|
||||||
|
|
||||||
|
|
Loading…
Add table
Add a link
Reference in a new issue