60be9fe7ca
The options in conf.py for the following build targets are either commented out or contain example values, which suggests that there was no interest in them recently. Their comments also seem more like generated examples. * LaTeX * man pages * Texinfo In order to clean up our configs and scripts for the documentation, remove the configuration options from conf.py for these build targets. Also, remove the build targets responsible for generating a PDF file from Makefile. Don't touch Makefile.sphinx for now though as we usually wrap around it. We may bring these build targets back if there is real interest in them, but it seems only the HTML target was really used. Change-Id: I7df8ea886f94d9b25e8eeb0ccbc2a7392b96a575 Signed-off-by: Felix Singer <felixsinger@posteo.net> Reviewed-on: https://review.coreboot.org/c/coreboot/+/77439 Reviewed-by: Martin L Roth <gaumless@gmail.com> Tested-by: build bot (Jenkins) <no-reply@coreboot.org>
50 lines
1.4 KiB
Makefile
50 lines
1.4 KiB
Makefile
## SPDX-License-Identifier: GPL-2.0-only
|
|
#
|
|
# Makefile for coreboot paper.
|
|
# hacked together by Stefan Reinauer <stepan@openbios.org>
|
|
#
|
|
|
|
BUILDDIR ?= _build
|
|
SPHINXOPTS ?= -j auto
|
|
|
|
export SPHINXOPTS
|
|
|
|
all: sphinx
|
|
|
|
$(BUILDDIR):
|
|
mkdir -p $(BUILDDIR)
|
|
|
|
sphinx: $(BUILDDIR)
|
|
$(MAKE) -f Makefile.sphinx html BUILDDIR="$(BUILDDIR)"
|
|
|
|
clean-sphinx:
|
|
$(MAKE) -f Makefile.sphinx clean BUILDDIR="$(BUILDDIR)"
|
|
|
|
clean: clean-sphinx
|
|
rm -f *.aux *.idx *.log *.toc *.out $(FIGS)
|
|
|
|
distclean: clean
|
|
rm -f corebootPortingGuide.pdf
|
|
|
|
livesphinx: $(BUILDDIR)
|
|
$(MAKE) -f Makefile.sphinx livehtml BUILDDIR="$(BUILDDIR)"
|
|
|
|
test:
|
|
@echo "Test for logging purposes - Failing tests will not fail the build"
|
|
-$(MAKE) -f Makefile.sphinx clean && $(MAKE) -K -f Makefile.sphinx html
|
|
-$(MAKE) -f Makefile.sphinx clean && $(MAKE) -K -f Makefile.sphinx doctest
|
|
|
|
help:
|
|
@echo "all - Builds all documentation targets"
|
|
@echo "sphinx - Builds html documentation in _build directory"
|
|
@echo "clean - Cleans intermediate files"
|
|
@echo "clean-sphinx - Removes sphinx output files"
|
|
@echo "distclean - Removes PDF files as well"
|
|
@echo "test - Runs documentation tests"
|
|
@echo
|
|
@echo " Makefile.sphinx builds - run with $(MAKE) -f Makefile-sphinx [target]"
|
|
@echo
|
|
@$(MAKE) -s -f Makefile.sphinx help 2>/dev/null
|
|
|
|
.phony: help livesphinx sphinx test
|
|
.phony: distclean clean clean-sphinx
|