mirror of
https://git.yoctoproject.org/poky
synced 2026-02-10 02:33:02 +01:00
12c0c41058
make sphinx-lint runs sphinx-lint on the whole documentation which can be long and reports a lot or errors/warnings. Let's add a new SHPINXLINTDOCS variable to allow specifying a subset, just as VALEDOCS does. Keep variable assignment aligned and also use $(SOURCEDIR) by default for SPHINXLINTDOCS and VALEDOCS variables. Also update the README file and fix a typo in Link checking section title. (From yocto-docs rev: ae46746897361d4177f3c4284f46753e3aa8c3c3) Signed-off-by: Julien Stephan <jstephan@baylibre.com> Reviewed-by: Antonin Godard <antonin.godard@bootlin.com> Tested-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> (cherry picked from commit 3dfe7b5c746af31de74f67cf88214e5d52bdb65d) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
73 lines
2.4 KiB
Makefile
73 lines
2.4 KiB
Makefile
# Minimal makefile for Sphinx documentation
|
|
#
|
|
|
|
# You can set these variables from the command line, and also
|
|
# from the environment for the first two.
|
|
SPHINXOPTS ?= -W --keep-going -j auto
|
|
SPHINXBUILD ?= sphinx-build
|
|
# Release notes are excluded because they contain contributor names and commit messages which can't be modified
|
|
VALEOPTS ?= --no-wrap --glob '!migration-guides/release-notes-*.rst'
|
|
SOURCEDIR = .
|
|
VALEDOCS ?= $(SOURCEDIR)
|
|
SPHINXLINTDOCS ?= $(SOURCEDIR)
|
|
IMAGEDIRS = */svg
|
|
BUILDDIR = _build
|
|
DESTDIR = final
|
|
SVG2PNG = inkscape
|
|
SVG2PDF = inkscape
|
|
|
|
ifeq ($(shell if which $(SPHINXBUILD) >/dev/null 2>&1; then echo 1; else echo 0; fi),0)
|
|
$(error "The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed")
|
|
endif
|
|
|
|
# Put it first so that "make" without argument is like "make help".
|
|
help:
|
|
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
|
|
|
|
.PHONY: all help Makefile clean stylecheck publish epub latexpdf
|
|
|
|
publish: Makefile html singlehtml
|
|
rm -rf $(BUILDDIR)/$(DESTDIR)/
|
|
mkdir -p $(BUILDDIR)/$(DESTDIR)/
|
|
cp -r $(BUILDDIR)/html/* $(BUILDDIR)/$(DESTDIR)/
|
|
cp $(BUILDDIR)/singlehtml/index.html $(BUILDDIR)/$(DESTDIR)/singleindex.html
|
|
sed -i -e 's@index.html#@singleindex.html#@g' $(BUILDDIR)/$(DESTDIR)/singleindex.html
|
|
|
|
# Build a list of SVG files to convert to PDFs
|
|
PDFs := $(foreach dir, $(IMAGEDIRS), $(patsubst %.svg,%.pdf,$(wildcard $(SOURCEDIR)/$(dir)/*.svg)))
|
|
|
|
# Build a list of SVG files to convert to PNGs
|
|
PNGs := $(foreach dir, $(IMAGEDIRS), $(patsubst %.svg,%.png,$(wildcard $(SOURCEDIR)/$(dir)/*.svg)))
|
|
|
|
# Pattern rule for converting SVG to PDF
|
|
%.pdf : %.svg
|
|
$(SVG2PDF) --export-filename=$@ $<
|
|
|
|
# Pattern rule for converting SVG to PNG
|
|
%.png : %.svg
|
|
$(SVG2PNG) --export-filename=$@ $<
|
|
|
|
clean:
|
|
@rm -rf $(BUILDDIR) $(PNGs) $(PDFs) poky.yaml sphinx-static/switchers.js
|
|
|
|
stylecheck:
|
|
vale sync
|
|
vale $(VALEOPTS) $(VALEDOCS)
|
|
|
|
sphinx-lint:
|
|
sphinx-lint $(SPHINXLINTDOCS)
|
|
|
|
epub: $(PNGs)
|
|
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
|
|
|
|
latexpdf: $(PDFs)
|
|
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
|
|
|
|
all: html epub latexpdf
|
|
|
|
# Catch-all target: route all unknown targets to Sphinx using the new
|
|
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
|
|
%:
|
|
$(SOURCEDIR)/set_versions.py
|
|
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
|