mirror of
https://github.com/apache/nuttx.git
synced 2025-05-08 22:32:04 +08:00
4f652e0622
Introduces `sphinx-tags` to the documentation system, allowing individual pages to be tagged for better searching. The examples in this commit introduce the `chip:*` tag for indicating the chip a board uses, as well as the `experimental` tag for indicating experimental boards and features. Other tags indicate supported peripherals for boards, such as `wifi` and `ethernet`. Signed-off-by: Matteo Golin <matteo.golin@gmail.com>
46 lines
1.5 KiB
ReStructuredText
46 lines
1.5 KiB
ReStructuredText
.. 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
|
||
implementation/index.rst
|
||
reference/index.rst
|
||
faq/index.rst
|
||
debugging/index.rst
|
||
guides/index.rst
|
||
glossary.rst
|
||
logos/index.rst
|
||
_tags/tagsindex.rst
|
||
|
||
.. include:: substitutions.rst
|