Documentation/Makefile

   1 ## SPDX-License-Identifier: GPL-2.0-only
   2 #
   3 # Makefile for coreboot paper.
   4 # hacked together by Stefan Reinauer <stepan@openbios.org>
   5 #
   6
   7 BUILDDIR ?= _build
   8 SPHINXOPTS ?= -j auto
   9
  10 export SPHINXOPTS
  11
  12 all: sphinx
  13
  14 $(BUILDDIR):
  15         mkdir -p $(BUILDDIR)
  16
  17 sphinx: $(BUILDDIR)
  18         $(MAKE) -f Makefile.sphinx html BUILDDIR="$(BUILDDIR)"
  19
  20 clean-sphinx:
  21         $(MAKE) -f Makefile.sphinx clean BUILDDIR="$(BUILDDIR)"
  22
  23 clean: clean-sphinx
  24         rm -f *.aux *.idx *.log *.toc *.out $(FIGS)
  25
  26 distclean: clean
  27         rm -f corebootPortingGuide.pdf
  28
  29 livesphinx: $(BUILDDIR)
  30         $(MAKE) -f Makefile.sphinx livehtml BUILDDIR="$(BUILDDIR)"
  31
  32 test:
  33         @echo "Test for logging purposes - Failing tests will not fail the build"
  34         -$(MAKE) -f Makefile.sphinx clean && $(MAKE) -K -f Makefile.sphinx html
  35         -$(MAKE) -f Makefile.sphinx clean && $(MAKE) -K -f Makefile.sphinx doctest
  36
  37 help:
  38         @echo "all            - Builds all documentation targets"
  39         @echo "sphinx         - Builds html documentation in _build directory"
  40         @echo "clean          - Cleans intermediate files"
  41         @echo "clean-sphinx   - Removes sphinx output files"
  42         @echo "distclean      - Removes PDF files as well"
  43         @echo "test           - Runs documentation tests"
  44         @echo
  45         @echo "  Makefile.sphinx builds - run with $(MAKE) -f Makefile-sphinx [target]"
  46         @echo
  47         @$(MAKE) -s -f Makefile.sphinx help 2>/dev/null
  48
  49 .phony: help livesphinx sphinx test
  50 .phony: distclean clean clean-sphinx