This is an automated email from the ASF dual-hosted git repository.
xiaoxiang pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/nuttx.git
The following commit(s) were added to refs/heads/master by this push:
new 1d06fe59052 doc: Improve sphinx build time + add autobuild help info.
1d06fe59052 is described below
commit 1d06fe5905201d1e73381976341ca63c582c3bb4
Author: Tomasz 'CeDeROM' CEDRO <[email protected]>
AuthorDate: Tue Jan 27 00:34:39 2026 +0100
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 <[email protected]>
---
Documentation/Makefile | 8 ++++++--
1 file changed, 6 insertions(+), 2 deletions(-)
diff --git a/Documentation/Makefile b/Documentation/Makefile
index 16bbf15313d..d9db5e3e885 100644
--- a/Documentation/Makefile
+++ b/Documentation/Makefile
@@ -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
