mirror of
https://github.com/apache/nuttx.git
synced 2026-05-10 07:18:49 +08:00
Tomasz 'CeDeROM' CEDRO
1d06fe5905
* 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>
53 lines
2.1 KiB
Makefile
53 lines
2.1 KiB
Makefile
##############################################################################
|
|
# Documentation/Makefile
|
|
#
|
|
# Licensed to the Apache Software Foundation (ASF) under one or more
|
|
# contributor license agreements. See the NOTICE file distributed with
|
|
# this work for additional information regarding copyright ownership. The
|
|
# ASF licenses this file to you under the Apache License, Version 2.0 (the
|
|
# "License"); you may not use this file except in compliance with the
|
|
# License. You may obtain a copy of the License at
|
|
#
|
|
# http://www.apache.org/licenses/LICENSE-2.0
|
|
#
|
|
# Unless required by applicable law or agreed to in writing, software
|
|
# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
|
|
# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
|
|
# License for the specific language governing permissions and limitations
|
|
# under the License.
|
|
#
|
|
##############################################################################
|
|
|
|
# Minimal makefile for Sphinx documentation
|
|
#
|
|
|
|
# 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 auto -W -A nuttx_versions="latest,${NUTTX_VERSIONS}"
|
|
SPHINXAUTOOPTS ?= -j auto -W --ignore "_tags/*"
|
|
SPHINXBUILD ?= sphinx-build
|
|
SPHINXAUTOBUILD ?= sphinx-autobuild
|
|
SOURCEDIR = .
|
|
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
|
|
|
|
html: clean
|
|
|
|
autobuild: clean
|
|
@$(SPHINXAUTOBUILD) "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXAUTOOPTS) $(O)
|
|
|
|
# Catch-all target: route all unknown targets to Sphinx using the new
|
|
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
|
|
%: Makefile
|
|
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
|