| Eric Fiselier | 8150bbf | 2015-09-05 05:12:04 +0000 | [diff] [blame^] | 1 | # Makefile for Sphinx documentation |
| 2 | # |
| 3 | |
| 4 | # You can set these variables from the command line. |
| 5 | SPHINXOPTS = |
| 6 | SPHINXBUILD = sphinx-build |
| 7 | PAPER = |
| 8 | BUILDDIR = _build |
| 9 | |
| 10 | # Internal variables. |
| 11 | PAPEROPT_a4 = -D latex_paper_size=a4 |
| 12 | PAPEROPT_letter = -D latex_paper_size=letter |
| 13 | ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . |
| 14 | # the i18n builder cannot share the environment and doctrees with the others |
| 15 | I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . |
| 16 | |
| 17 | .PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext default |
| 18 | |
| 19 | default: html |
| 20 | |
| 21 | help: |
| 22 | @echo "Please use \`make <target>' where <target> is one of" |
| 23 | @echo " html to make standalone HTML files" |
| 24 | |
| 25 | clean: |
| 26 | -rm -rf $(BUILDDIR)/* |
| 27 | |
| 28 | html: |
| 29 | $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html |
| 30 | @echo |
| 31 | @# FIXME: Remove this `cp` once HTML->Sphinx transition is completed. |
| 32 | @# Kind of a hack, but HTML-formatted docs are on the way out anyway. |
| 33 | @echo "Build finished. The HTML pages are in $(BUILDDIR)/html." |
| 34 | |