doc: restructure documentation
With the new theme we are able to have more section in the top level. Move things around and expose the most important sections in the top table of content. Signed-off-by: Anas Nashif <anas.nashif@intel.com>
This commit is contained in:
parent
6b22a93286
commit
276c589dc3
19 changed files with 57 additions and 54 deletions
|
@ -1,10 +1,7 @@
|
|||
.. _api:
|
||||
|
||||
API Documentation
|
||||
#################
|
||||
|
||||
Welcome to the Zephyr Project's :abbr:`API (Application Programing Interface)`
|
||||
documentation.
|
||||
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.
|
|
@ -1,7 +1,7 @@
|
|||
.. _application:
|
||||
|
||||
Application Development Primer
|
||||
##############################
|
||||
Application Development
|
||||
#######################
|
||||
|
||||
.. note::
|
||||
|
||||
|
|
|
@ -1,18 +0,0 @@
|
|||
.. _developer_guides:
|
||||
|
||||
Developer Guides
|
||||
################
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
|
||||
application.rst
|
||||
../samples/samples.rst
|
||||
../reference/kconfig/index.rst
|
||||
../api/api.rst
|
||||
../porting/porting.rst
|
||||
kconfig-tips.rst
|
||||
../README.rst
|
||||
../west/index.rst
|
||||
coccinelle.rst
|
||||
relocation.rst
|
|
@ -1,13 +0,0 @@
|
|||
.. _contribute:
|
||||
|
||||
Contribution Guide
|
||||
##################
|
||||
|
||||
As an open-source project, we welcome and encourage the community to submit
|
||||
patches for code, documentation, tests, and more, directly to the project.
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
|
||||
contribute_guidelines.rst
|
||||
doc-guidelines.rst
|
|
@ -1,10 +1,10 @@
|
|||
.. _device-tree:
|
||||
|
||||
Device Tree in Zephyr
|
||||
########################
|
||||
Device Tree
|
||||
###########
|
||||
|
||||
Introduction to Device Tree
|
||||
***************************
|
||||
Introduction
|
||||
************
|
||||
|
||||
Device tree is a way of describing hardware and configuration information
|
||||
for boards. Device tree was adopted for use in the Linux kernel for the
|
||||
|
|
10
doc/documentation/index.rst
Normal file
10
doc/documentation/index.rst
Normal file
|
@ -0,0 +1,10 @@
|
|||
.. _documentation_guidelines:
|
||||
|
||||
Documentation Guidelines
|
||||
########################
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
|
||||
../README.rst
|
||||
doc-guidelines.rst
|
|
@ -50,13 +50,19 @@ Source code for the Zephyr Project is maintained in the Zephyr Project's
|
|||
|
||||
introduction/introducing_zephyr.rst
|
||||
getting_started/getting_started.rst
|
||||
application/index.rst
|
||||
boards/boards.rst
|
||||
contribute/index.rst
|
||||
documentation/index.rst
|
||||
application/application.rst
|
||||
kernel/kernel.rst
|
||||
devices/index.rst
|
||||
subsystems/subsystems.rst
|
||||
contribute/contribute.rst
|
||||
security/security.rst
|
||||
subsystems/subsystems.rst
|
||||
devices/index.rst
|
||||
tools/index.rst
|
||||
porting/index.rst
|
||||
samples/samples.rst
|
||||
api/index.rst
|
||||
boards/boards.rst
|
||||
reference/index.rst
|
||||
|
||||
.. only:: html
|
||||
|
||||
|
|
|
@ -1,7 +1,7 @@
|
|||
.. _kernel:
|
||||
|
||||
Kernel Primer
|
||||
#############
|
||||
Kernel Services
|
||||
###############
|
||||
|
||||
This document provides a general introduction of the Zephyr kernel's
|
||||
key capabilities and services. Additional details can be found by consulting
|
||||
|
|
|
@ -1,7 +1,7 @@
|
|||
.. _porting:
|
||||
|
||||
Porting Guides
|
||||
##############
|
||||
Porting
|
||||
#######
|
||||
|
||||
This section contains details regarding porting the Zephyr kernel to new
|
||||
architectures, SoCs and boards. This section also describes the standard
|
9
doc/reference/index.rst
Normal file
9
doc/reference/index.rst
Normal file
|
@ -0,0 +1,9 @@
|
|||
.. _reference:
|
||||
|
||||
Reference
|
||||
##########
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
|
||||
kconfig/index.rst
|
12
doc/tools/index.rst
Normal file
12
doc/tools/index.rst
Normal file
|
@ -0,0 +1,12 @@
|
|||
.. _developer_guides:
|
||||
|
||||
Tools
|
||||
######
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
|
||||
kconfig/index.rst
|
||||
west/index.rst
|
||||
coccinelle.rst
|
||||
code-relocation.rst
|
|
@ -1,7 +1,7 @@
|
|||
.. _kconfig_tips_and_tricks:
|
||||
|
||||
Kconfig tips and best practices
|
||||
###############################
|
||||
Kconfig - Tips and Best Practices
|
||||
#################################
|
||||
|
||||
This page covers some Kconfig best practices and explains some Kconfig
|
||||
behaviors and features that might be cryptic or that are easily overlooked.
|
||||
|
@ -40,7 +40,7 @@ See the `optional prompts`_ section for a way to deal with settings that are
|
|||
fixed on some machines and configurable on other machines.
|
||||
|
||||
|
||||
Best practices for ``select`` statements
|
||||
``select`` statements
|
||||
****************************************
|
||||
|
||||
The ``select`` statement is used to force one symbol to ``y`` whenever another
|
Loading…
Add table
Add a link
Reference in a new issue