2015-09-05 05:12:04 +00:00
|
|
|
# Makefile for Sphinx documentation
|
|
|
|
|
#
|
2015-09-05 05:29:23 +00:00
|
|
|
# FIXME: This hack is only in place to allow the libcxx.llvm.org/docs builder
|
|
|
|
|
# to work with libcxx. This should be removed when that builder supports
|
|
|
|
|
# out-of-tree builds.
|
2015-09-05 05:12:04 +00:00
|
|
|
|
|
|
|
|
# You can set these variables from the command line.
|
2018-07-25 02:53:53 +00:00
|
|
|
SPHINXOPTS = -n -W -v
|
2015-09-05 05:12:04 +00:00
|
|
|
SPHINXBUILD = sphinx-build
|
|
|
|
|
PAPER =
|
|
|
|
|
BUILDDIR = _build
|
|
|
|
|
|
|
|
|
|
# Internal variables.
|
|
|
|
|
PAPEROPT_a4 = -D latex_paper_size=a4
|
|
|
|
|
PAPEROPT_letter = -D latex_paper_size=letter
|
|
|
|
|
ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
|
|
|
|
|
# the i18n builder cannot share the environment and doctrees with the others
|
|
|
|
|
I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
|
|
|
|
|
|
|
|
|
|
.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext default
|
|
|
|
|
|
|
|
|
|
default: html
|
|
|
|
|
|
|
|
|
|
help:
|
|
|
|
|
@echo "Please use \`make <target>' where <target> is one of"
|
|
|
|
|
@echo " html to make standalone HTML files"
|
|
|
|
|
|
|
|
|
|
clean:
|
|
|
|
|
-rm -rf $(BUILDDIR)/*
|
|
|
|
|
|
|
|
|
|
html:
|
|
|
|
|
$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
|
|
|
|
|
@echo
|
|
|
|
|
@# FIXME: Remove this `cp` once HTML->Sphinx transition is completed.
|
|
|
|
|
@# Kind of a hack, but HTML-formatted docs are on the way out anyway.
|
|
|
|
|
@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
|
|
|
|
|
|
