Mirrors_Framework/nuttx
1
0
Fork 0
mirror of https://github.com/apache/nuttx.git synced 2026-09-22 14:41:29 +08:00
Code Issues Actions 8 Packages Projects Releases Wiki Activity
61,977 Commits 24 Branches 206 Tags
eec293cd7abf9840bee8c709cf662b2176fc0dfd
Commit Graph
14 Commits
Author SHA1 Message Date
Matteo Golin 16aca58275 docs/plantuml: Add PlantUML support to Documentation build 
This commit adds support for PlantUML to the Documentation build
process. UML diagrams can be written in PlantUML syntax and then
rendered during the build process. Version control no longer needs to
track these UML diagrams as images, and we can modify them easily.

Signed-off-by: Matteo Golin <matteo.golin@gmail.com>
 2026-02-15 08:47:23 +01:00
Niccolò Maggioni 2d2defb8a0 docs: Fix pipenv lockfile for older Python versions
Build Documentation / build-html (push) Has been cancelled
Details 
CI uses Python 3.8

Signed-off-by: Niccolò Maggioni <nicco.maggioni+nuttx@gmail.com>
 2025-06-11 23:11:08 +08:00
Niccolò Maggioni 2399702a28 docs: Update the ELF guides 
Rewrite parts of the two ELF guides to use scripts included in the
export archive and modernize some deprecated tools and Bash idioms.

Also add the new sphinx_collapse extension to the docs build config.

Signed-off-by: Niccolò Maggioni <nicco.maggioni+nuttx@gmail.com>
 2025-06-11 23:11:08 +08:00
Matteo Golin 4f652e0622 docs/tags: Introduce tagging feature to the documentation. 
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>
 2025-04-29 09:18:25 +02:00
dependabot[bot] 52ac99126d Documentation: Bump docutils from 0.18.1 to 0.19 
This PR bumps the version of docutils from 0.18.1 to 0.19, as requested by dependabot:
- https://github.com/apache/nuttx/pull/14910
 2024-11-24 17:52:30 +08:00
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
Brennan Ashton 14d311ca0a docs: Add copy button for code blocks 2023-05-20 12:58:32 +08:00
Brennan Ashton c9636f0b3e docs: Update dependencies and fix lint errors 2022-10-10 09:29:53 +08:00
Matias N d3fe676d0a Documentation: update pipenv to include sphinx-autobuild 2021-04-07 22:34:33 +01: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
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 4276d6254a rename doc/ -> Documentation/ 2020-08-24 10:29:55 -07:00