incubator-nuttx/Documentation/components/index.rst

OS Components
=============

NuttX is very feature-rich RTOS and is thus composed of various different
subsystems. The following sections explain how each of these main RTOS components
work and can be used. For detailed documentation on the specific API used in this
case, you can head to the :doc:`reference <../reference/index>`.

.. toctree::
   :maxdepth: 2
   :caption: Contents:
   
   power.rst
   binfmt.rst
   drivers/index.rst
   nxflat.rst
   nxgraphics/index.rst
   nxwidgets.rst
   paging.rst
   audio/index.rst
   filesystem/index.rst
   libs/index.rst
   net/index.rst
   mm/index.rst
   syscall.rst
   tools/index.rst
   arch/index.rst
   boards.rst
sphinx doc 2020-07-21 06:18:26 +08:00			`OS Components`
			`=============`

Documentation: cosmetics changes - various style fixes - limit the line length to about 80 characters to improve readability in terminal-based IDEs 2023-10-26 19:10:13 +08:00			`NuttX is very feature-rich RTOS and is thus composed of various different`
			`subsystems. The following sections explain how each of these main RTOS components`
			`work and can be used. For detailed documentation on the specific API used in this`
			case, you can head to the :doc:`reference <../reference/index>`.
Documentation: Remove all tail spaces from .rst and .html by the below command: find . -type f -name '*.rst' -exec sed --in-place 's/[[:space:]]\+$//' {} \+ Signed-off-by: Xiang Xiao <xiaoxiang@xiaomi.com> 2020-10-19 00:48:44 +08:00
sphinx doc 2020-07-21 06:18:26 +08:00			`.. toctree::`
			`:maxdepth: 2`
			`:caption: Contents:`

			`power.rst`
			`binfmt.rst`
			`drivers/index.rst`
			`nxflat.rst`
			`nxgraphics/index.rst`
			`nxwidgets.rst`
			`paging.rst`
Documentation: migrate /audio 2023-10-25 21:20:40 +08:00			`audio/index.rst`
Documentation: migrate /fs 2023-10-25 21:21:20 +08:00			`filesystem/index.rst`
Documentation: migrate /libs 2023-10-25 21:21:50 +08:00			`libs/index.rst`
Documentation: migrate /net 2023-10-25 21:22:15 +08:00			`net/index.rst`
Documentation: migrate /mm 2023-10-25 21:22:48 +08:00			`mm/index.rst`
Documentation: migrate /syscall 2023-10-25 21:23:21 +08:00			`syscall.rst`
Documentation: migrate /tools 2023-10-25 21:26:30 +08:00			`tools/index.rst`
Documentation: migrate /arch 2023-10-25 21:26:43 +08:00			`arch/index.rst`
Documentation: migrate the rest boards - migrated /README are removed from /boards - there are a lot of READMEs that should be further converted to rst. At the moment they are moved to Documentation/platforms and included in rst files 2023-10-26 02:28:04 +08:00			`boards.rst`