Restructured the API documentation and moved it from the Reference section to the Developer guides section. Added a note about the search function to help users find the API they are looking for faster. Splitted the API docs into two files one for nanokernel and another for the microkernel APIs. Added table of contents for each of the API sections with a back link on the headings to take the users back to the top of the page. Making navigation easier and more user friendly. Change-Id: I80f415a60ea9c7df22276b464013e906e1efa511 Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
22 lines
601 B
ReStructuredText
22 lines
601 B
ReStructuredText
.. _api:
|
|
|
|
API Documentation
|
|
#################
|
|
|
|
Welcome to the Zephyr Project's
|
|
:abbr:`API (Application Programing Interface)` documentation.
|
|
|
|
This section contains the API documentation automatically extracted from the
|
|
code. To ease navigation, we have split the APis in nanokernel APIs and
|
|
microkernel APIs. 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 use of the Zephyr APIs is the same for all platforms and boards.
|
|
|
|
.. toctree::
|
|
:maxdepth: 2
|
|
|
|
nanokernel_api.rst
|
|
microkernel_api.rst
|