Commit Graph

10 Commits

Author SHA1 Message Date
Alan Carvalho de Assis
b998afdc04 doc: Fix Documentation build procedure
User reported an issue caused by not clear documentation:
https://github.com/apache/nuttx/issues/13232
2024-08-30 23:18:32 +08:00
Nathan Hartman
26f09cec6d Documentation: Fix a few typos.
* Documentation/contributing/documentation.rst
    * Documentation/guides/tasktraceuser.rst
    * Documentation/guides/drivers.rst
    * Documentation/quickstart/running.rst
    * Documentation/quickstart/compiling.rst
    * Documentation/components/drivers/character/watchdog.rst
    * Documentation/components/drivers/character/foc.rst
    * Documentation/components/nxgraphics/nxtk.rst
    * Documentation/applications/nsh/login.rst
    * Documentation/introduction/detailed_support.rst
    * Documentation/introduction/resources.rst
    * Documentation/reference/user/01_task_control.rst
    * Documentation/reference/os/wqueue.rst

      Fix some misspelled words.

      Many of these were caught by codespell.
2021-04-28 17:00:23 -03:00
Matias N
33aafe8e7f doc: mention sphinx-autobuild in contributing section 2021-03-26 23:41:45 -05:00
Xiang Xiao
598e3eedb4 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-18 10:51:22 -07:00
Matias N
94e1a9247c documentation: work on quickstart, add tabs sphinx extension 2020-09-12 19:28:24 -07:00
Brennan Ashton
572be4d74d Docs: Clean up installation requirements and only support pipenv
Signed-off-by: Brennan Ashton <bashton@brennanashton.com>
2020-09-02 17:12:32 -03:00
Matias N
f8207ded75 doc: remove todo 2020-08-25 12:54:24 -07:00
Matias N
911cc3f0ea fix wrong "todo" placement 2020-08-24 10:29:55 -07:00
Matias N
3f723a247d add basic documentation contributing guidelines 2020-08-24 10:29:55 -07:00
Matias N
4276d6254a rename doc/ -> Documentation/ 2020-08-24 10:29:55 -07:00