Commit graph

10 commits

Author SHA1 Message Date
Tomasz 'CeDeROM' CEDRO
1d06fe5905 doc: Improve sphinx build time + add autobuild help info.
* Update previous `-j 1` and `-j 8` switch to `-j auto` to use all CPUs.
* This improves doc build time 62s -> 25s on 24 core CPU.
* Add information about `make autobuild` to `make help`.
* Auotbuild is very handy for quick edits preview and was not in help before.

Signed-off-by: Tomasz 'CeDeROM' CEDRO <tomek@cedro.info>
2026-01-27 09:50:55 +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
Saurav Pal
93d03d0418 fs: Add VFS docs
This commit adds VFS docmentation, and details about the VFS interface.

Signed-off-by: Saurav Pal <resyfer.dev@gmail.com>
2024-02-20 18:28:09 -08:00
raiden00pl
9858dfde32 Documentation: disable parallel build 2023-11-29 01:37:10 -08:00
raiden00pl
de199faed6 Documentation: turn warnings into errors 2023-11-29 01:37:10 -08:00
Matias N
33aafe8e7f doc: mention sphinx-autobuild in contributing section 2021-03-26 23:41:45 -05:00
Matias N
a59c7744f8 Documentation: support versioned docs 2020-11-26 10:58:44 -08:00
Matias N
7b965a25d8 Documentation: build documentation using sphinx -j option which parallelizes jobs 2020-09-12 00:43:22 +08:00
Matias N
1f53dd0e0e documentation: add license headers to various files 2020-08-24 10:29:55 -07:00
Matias N
4276d6254a rename doc/ -> Documentation/ 2020-08-24 10:29:55 -07:00
Renamed from doc/Makefile (Browse further)