incubator-nuttx/Documentation/index.rst

.. note::
  The present documentation is a recent addition to NuttX and was migrated from previous
  documentation content. For this reason, it is possible you may find broken links or
  formatting errors. You can help contribute fixes or improvements to this documentation
  by following these :doc:`instructions <contributing/documentation>`.

.. tip::
  You can find the old documentation `here <https://cwiki.apache.org/confluence/display/NUTTX/Documentation>`_.

===================
NuttX Documentation
===================

NuttX is a real-time operating system (RTOS) with an emphasis on standards
compliance and small footprint. Scalable from 8-bit to 64-bit microcontroller
environments, the primary governing standards in NuttX are POSIX and ANSI
standards. Additional standard APIs from Unix and other common RTOS’s (such as
VxWorks) are adopted for functionality not available under these standards, or
for functionality that is not appropriate for deeply-embedded environments (such
as fork()).

Last Updated: |today|

.. toctree::
   :caption: Table of Contents
   :maxdepth: 2

   Home <self>
   introduction/index.rst
   quickstart/index.rst
   contributing/index.rst
   introduction/inviolables.rst
   platforms/index.rst
   components/index.rst
   applications/index.rst
   reference/index.rst
   faq/index.rst
   guides/index.rst
   glossary.rst

.. include:: substitutions.rst
-												convert TODOs to actual TODO banner and improve general presentation of different sections

											
										
										
											2020-08-16 05:10:25 +08:00
+								.. note::
-												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
+								  The present documentation is a recent addition to NuttX and was migrated from previous
-												convert TODOs to actual TODO banner and improve general presentation of different sections

											
										
										
											2020-08-16 05:10:25 +08:00
+								  documentation content. For this reason, it is possible you may find broken links or
 								  formatting errors. You can help contribute fixes or improvements to this documentation
 								  by following these :doc:`instructions <contributing/documentation>`.
 								.. tip::
-												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
+								  You can find the old documentation `here <https://cwiki.apache.org/confluence/display/NUTTX/Documentation>`_.
-												sphinx doc

											
										
										
											2020-07-21 06:18:26 +08:00
+								===================
 								NuttX Documentation
 								===================
-												Documentation: split some long lines

											
										
										
											2023-10-28 16:40:46 +08:00
+								NuttX is a real-time operating system (RTOS) with an emphasis on standards
 								compliance and small footprint. Scalable from 8-bit to 64-bit microcontroller
 								environments, the primary governing standards in NuttX are POSIX and ANSI
 								standards. Additional standard APIs from Unix and other common RTOS’s (such as
 								VxWorks) are adopted for functionality not available under these standards, or
 								for functionality that is not appropriate for deeply-embedded environments (such
 								as fork()).
-												sphinx doc

											
										
										
											2020-07-21 06:18:26 +08:00
 								Last Updated: |today|
 								.. toctree::
-												convert TODOs to actual TODO banner and improve general presentation of different sections

											
										
										
											2020-08-16 05:10:25 +08:00
+								   :caption: Table of Contents
-												sphinx doc

											
										
										
											2020-07-21 06:18:26 +08:00
+								   :maxdepth: 2
 								   Home <self>
-												Documentation: reorder introduction in index

											
										
										
											2020-11-22 06:53:56 +08:00
+								   introduction/index.rst
-												sphinx doc

											
										
										
											2020-07-21 06:18:26 +08:00
+								   quickstart/index.rst
-												Move "Contributing" to be after getting started

											
										
										
											2021-08-23 20:36:11 +08:00
+								   contributing/index.rst
-												Documentation: Reorder Documentation/index.rst

1.Move quickstart to first
2.Move boards after introduction
3.Move reference after guides

Signed-off-by: Xiang Xiao <xiaoxiang@xiaomi.com>

											
										
										
											2020-10-19 01:05:17 +08:00
+								   introduction/inviolables.rst
-												Documentation: introduce hardware platforms documentation

											
										
										
											2021-02-07 09:31:17 +08:00
+								   platforms/index.rst
-												sphinx doc

											
										
										
											2020-07-21 06:18:26 +08:00
+								   components/index.rst
 								   applications/index.rst
-												Documentation: Reorder Documentation/index.rst

1.Move quickstart to first
2.Move boards after introduction
3.Move reference after guides

Signed-off-by: Xiang Xiao <xiaoxiang@xiaomi.com>

											
										
										
											2020-10-19 01:05:17 +08:00
+								   reference/index.rst
-												Documentation: Add FAQ entry

											
										
										
											2021-04-15 00:46:51 +08:00
+								   faq/index.rst
-												Documentation: remove empty releases section; put reference up higher

											
										
										
											2020-11-22 08:49:39 +08:00
+								   guides/index.rst
-												convert acronyms.txt to glossary.rst

											
										
										
											2020-08-15 02:26:05 +08:00
+								   glossary.rst
-												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
+								.. include:: substitutions.rst