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>
This commit is contained in:
Tomasz 'CeDeROM' CEDRO
2026-01-27 00:34:39 +01:00
committed by Xiang Xiao
parent 9bda244be8
commit 1d06fe5905
+6 -2
View File
@@ -24,8 +24,8 @@
# You can set these variables from the command line, and also
# from the environment for the first two.
# Ignore the _tags directory as per sphinx-tags docs to avoid infinite loop
SPHINXOPTS ?= -j 1 -W -A nuttx_versions="latest,${NUTTX_VERSIONS}"
SPHINXAUTOOPTS ?= -j 8 -W --ignore "_tags/*"
SPHINXOPTS ?= -j auto -W -A nuttx_versions="latest,${NUTTX_VERSIONS}"
SPHINXAUTOOPTS ?= -j auto -W --ignore "_tags/*"
SPHINXBUILD ?= sphinx-build
SPHINXAUTOBUILD ?= sphinx-autobuild
SOURCEDIR = .
@@ -33,6 +33,10 @@ BUILDDIR = _build
# Put it first so that "make" without argument is like "make help".
help:
$(info =>)
$(info => Use `make autobuild` to build live preview of the documentation.)
$(info => You can then watch live edit changes at http://localhost:8000.)
$(info =>)
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
.PHONY: help Makefile