Docs: Update sphinx targets with the build directory

Because Makefile.sphinx looks like a standard makefile from the sphinx
project, it probably shouldn't be updated without good reason. This
change lets us update the output directory and tell the Makefile.sphinx
where we want the output.

Also fix the spacing on PDFLATEX to match the new SPHINXDIR variable.

Signed-off-by: Martin Roth <gaumless@gmail.com>
Change-Id: Iab111e8feea8ec02260f39636e7c17fd1cae7c30
Reviewed-on: https://review.coreboot.org/c/coreboot/+/75499
Tested-by: build bot (Jenkins) <no-reply@coreboot.org>
Reviewed-by: Elyes Haouas <ehaouas@noos.fr>
Reviewed-by: Felix Singer <service+coreboot-gerrit@felixsinger.de>
This commit is contained in:
Martin Roth 2023-05-29 23:09:54 -06:00 committed by Felix Singer
parent 34e43f602f
commit 4d8da8ed77
1 changed files with 10 additions and 6 deletions

View File

@ -5,6 +5,7 @@
# #
PDFLATEX = pdflatex -t a4 PDFLATEX = pdflatex -t a4
SPHINXDIR = _build
FIGS=codeflow.pdf hypertransport.pdf FIGS=codeflow.pdf hypertransport.pdf
@ -32,6 +33,9 @@ else ifneq ($(strip $(CONVERT)),)
convert $< $@ convert $< $@
endif endif
$(SPHINXDIR):
mkdir -p $(SPHINXDIR)
corebootPortingGuide.toc: $(FIGS) corebootBuildingGuide.tex corebootPortingGuide.toc: $(FIGS) corebootBuildingGuide.tex
# 2 times to make sure we have a current toc. # 2 times to make sure we have a current toc.
$(PDFLATEX) corebootBuildingGuide.tex $(PDFLATEX) corebootBuildingGuide.tex
@ -40,11 +44,11 @@ corebootPortingGuide.toc: $(FIGS) corebootBuildingGuide.tex
corebootPortingGuide.pdf: $(FIGS) corebootBuildingGuide.tex corebootPortingGuide.toc corebootPortingGuide.pdf: $(FIGS) corebootBuildingGuide.tex corebootPortingGuide.toc
$(PDFLATEX) corebootBuildingGuide.tex $(PDFLATEX) corebootBuildingGuide.tex
sphinx: sphinx: $(SPHINXDIR)
$(MAKE) -f Makefile.sphinx html $(MAKE) -f Makefile.sphinx html BUILDDIR="$(SPHINXDIR)""
clean-sphinx: clean-sphinx:
$(MAKE) -f Makefile.sphinx clean $(MAKE) -f Makefile.sphinx clean BUILDDIR="$(SPHINXDIR)"
clean: clean-sphinx clean: clean-sphinx
rm -f *.aux *.idx *.log *.toc *.out $(FIGS) rm -f *.aux *.idx *.log *.toc *.out $(FIGS)
@ -52,8 +56,8 @@ clean: clean-sphinx
distclean: clean distclean: clean
rm -f corebootPortingGuide.pdf rm -f corebootPortingGuide.pdf
livesphinx: livesphinx: $(SPHINXDIR)
$(MAKE) -f Makefile.sphinx livehtml SPHINXOPTS="$(SPHINXOPTS)" $(MAKE) -f Makefile.sphinx livehtml SPHINXOPTS="$(SPHINXOPTS)" BUILDDIR="$(SPHINXDIR)"
test: test:
@echo "Test for logging purposes - Failing tests will not fail the build" @echo "Test for logging purposes - Failing tests will not fail the build"