Commit Graph

19 Commits

Author SHA1 Message Date
raiden00pl
55170d2ca2 Documentation: replace m2r2 with myst-parser
sphinx recommends myst-parser for markdown conversion:
https://www.sphinx-doc.org/en/master/usage/markdown.html

m2r2 is not supported for Python versions >= 3.12 so
we can't build Documentation for example on latest Arch Linux

by the way myst-parser detected a bad link to SECURITY.md that is now fixed
2024-08-30 01:14:36 +08:00
raiden00pl
6dfe1bf58c Documentation: port warnings_filter Sphinx extension from Zephyr
ignore known warnings:

/home/raiden00/git/RTOS/nuttx/nuttx/Documentation/reference/os/netdev.rst:61: WARNING: Duplicate C declaration, also defined at reference/os/netdev:39.
Declaration is '.. c:struct:: net_driver_s'.
/home/raiden00/git/RTOS/nuttx/nuttx/Documentation/reference/user/07_signals.rst:180: WARNING: Duplicate C declaration, also defined at reference/user/structures:112.
Declaration is '.. c:struct:: sigaction'.
2023-11-28 09:18:29 -08:00
raiden00pl
93f1d62f34 Documentation: fix warning
Documentation/legacy_README.md: WARNING: document isn't included in any toctree
2023-10-30 20:29:54 +08:00
raiden00pl
a2bb55d8b7 Documentation: update copyright year 2023-10-27 13:21:40 -03:00
Brennan Ashton
14d311ca0a docs: Add copy button for code blocks 2023-05-20 12:58:32 +08:00
Brennan Ashton
9a654b658e docs: Generate pdf version of docs for #9095
This implements the changes required to genreate the pdf version
of the documentation. The pdf will be generated as a build artifact
attached to the build. This is the first patch to enable this
a follow on patch to the website repo will publish the pdf to the
NuttX website.
2023-05-16 15:12:10 +08:00
Christian Clauss
15932fa9ea Lint Python code with flake8 and isort 2021-04-10 08:36:29 -07:00
Brennan Ashton
f2b799842e lint Documentation/ 2021-04-04 23:29:27 -05:00
Matias N
87596d74dd Documentation: introduce hardware platforms documentation 2021-02-07 08:38:51 -03:00
Matias N
9c83b407b4 Documentation: re-enable prev, next buttons 2020-12-05 21:43:35 -06:00
Matias N
a59c7744f8 Documentation: support versioned docs 2020-11-26 10:58:44 -08:00
Brennan Ashton
23cd1e030e Docs: Fix broken links and references in docs
Also add to the CI a problem matcher to better report issues

Signed-off-by: Brennan Ashton <bashton@brennanashton.com>
2020-10-22 10:22:11 -03:00
Matias N
94e1a9247c documentation: work on quickstart, add tabs sphinx extension 2020-09-12 19:28:24 -07:00
Adam Feuer
d655f47d13 convert INVIOLABLES.txt to markdown, add to docs 2020-08-25 16:03:42 -07:00
Matias N
8d5d5502bc documentation: switch to m2r2 for Markdown support; update requirements.txt 2020-08-25 12:54:24 -07:00
Matias N
1f53dd0e0e documentation: add license headers to various files 2020-08-24 10:29:55 -07:00
Matias N
d9be1dffab add basic support for multiple versions 2020-08-24 10:29:55 -07:00
Matias N
4a38a15332 convert TODOs to actual TODO banner and improve general presentation of different sections 2020-08-24 10:29:55 -07:00
Matias N
4276d6254a rename doc/ -> Documentation/ 2020-08-24 10:29:55 -07:00