Documentation/Makefile.sphinx

   1 ## SPDX-License-Identifier: GPL-2.0-only
   2 # Minimal makefile for Sphinx documentation
   3 #
   4
   5 # You can set these variables from the command line, and also
   6 # from the environment for the first two.
   7 SPHINXOPTS    ?=
   8 SPHINXBUILD   ?= sphinx-build
   9 SPHINXAUTOBUILD = sphinx-autobuild
  10 SOURCEDIR     = .
  11 BUILDDIR      = _build
  12
  13 # Put it first so that "make" without argument is like "make help".
  14 help:
  15         @$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
  16
  17 .PHONY: help Makefile.sphinx
  18
  19 .PHONY: livehtml
  20 livehtml:
  21         @echo "Starting sphinx-autobuild. The HTML pages are in $(BUILDDIR)."
  22         @echo "Press Ctrl-C to stop."
  23         @echo
  24         $(SPHINXAUTOBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)
  25
  26 # Catch-all target: route all unknown targets to Sphinx using the new
  27 # "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
  28 %: Makefile.sphinx
  29         @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)