Commit Graph

4 Commits

Author SHA1 Message Date
Brennan Ashton
4d3ce8f706 docs: Fix sphinx warnings listed in issue #9306
Fixes these errors:
```
 /home/bashton/nuttx-wrk/nuttx/Documentation/components/drivers/special/lcd.rst:52: WARNING: duplicate label ttgotdisplayesp32, other instance in /home/bashton/nuttx-wrk/nuttx/Documentation/components/drivers/special/framebuffer.rst
 /home/bashton/nuttx-wrk/nuttx/Documentation/platforms/sim/sim/boards/sim/index.rst:370: CRITICAL: Unexpected section title.
 /home/bashton/nuttx-wrk/nuttx/Documentation/platforms/sim/sim/boards/sim/index.rst:394: CRITICAL: Unexpected section title.
 /home/bashton/nuttx-wrk/nuttx/Documentation/platforms/sim/sim/boards/sim/index.rst:1494: ERROR: Inconsistent literal block quoting.
 /home/bashton/nuttx-wrk/nuttx/Documentation/platforms/sim/sim/boards/sim/index.rst:1569: WARNING: Literal block expected; none found.
 /home/bashton/nuttx-wrk/nuttx/Documentation/platforms/xtensa/esp32s2/boards/esp32s2-kaluga-1/index.rst:207: WARNING: download file not readable: /home/bashton/nuttx-wrk/nuttx/Documentation/platforms/xtensa/esp32s2/boards/esp32s2-kaluga-1/tone.wav
 checking consistency... /home/bashton/nuttx-wrk/nuttx/Documentation/reference/os/newreno.rst: WARNING: document isn't included in any toctree
 /home/bashton/nuttx-wrk/nuttx/Documentation/guides/zerolatencyinterrupts.rst:117: WARNING: unknown document: <nestedinterrupts.rst>
```
2023-05-20 12:40:52 +08:00
Nathan Hartman
e299af410a Documentation: Import Nested Interrupts page from CWIKI
* Documentation/guides/nestedinterrupts.rst:
  New. Imported from [1] and converted from CWIKI to reStructuredText.

* Documentation/guides/index.rst:
  Link to the new page.

* Documentation/guides/zerolatencyinterrupts.rst:
  Replace link to the CWIKI Nested Interrupts page with link to the
  above.

[1] https://cwiki.apache.org/confluence/display/NUTTX/Nested+Interrupts
2023-05-19 23:20:43 +08:00
Nathan Hartman
33bf661413 Documentation: Improve "High Performance, Zero Latency Interrupts"
* Documentation/guides/zerolatencyinterrupts.rst:
  Add paragraph that defines jitter. Fix a few minor typos. Fix
  incorrect reStructuredText formatting for bulletpoints (they were
  being rendered like 2nd level bulletpoints).

* Documentation/guides/index.rst:
  Add zerolatencyinterrupts.rst to the TOC, which I forgot to do in PR
  # 9302.
2023-05-19 10:22:50 +08:00
Nathan Hartman
242127556c Documentation: Add "High Performance, Zero Latency Interrupts"
* Documentation/guides/zerolatencyinterrupts.rst: New. This document is
  converted from CWIKI (see [1]) to reStructuredText and brought into
  the Documentation tree in the repo.

[1] https://cwiki.apache.org/confluence/display/NUTTX/High+Performance%2C+Zero+Latency+Interrupts
2023-05-17 02:23:19 +08:00