sphinx / doc / Makefile

# Makefile for Sphinx documentation

# You can set these variables from the command line.
SPHINXBUILD  = python ../sphinx-build.py
PAPER        =

PAPEROPT_a4      = -D latex_paper_size=a4
PAPEROPT_letter  = -D latex_paper_size=letter
ALLSPHINXOPTS = -d _build/doctrees $(PAPEROPT_$(PAPER)) \
                $(SPHINXOPTS) $(O) .

.PHONY: help clean html dirhtml singlehtml text man pickle json htmlhelp \
	qthelp devhelp epub latex latexpdf changes linkcheck doctest

	@echo "Please use \`make <target>' where <target> is one of"
	@echo "  html       to make standalone HTML files"
	@echo "  dirhtml    to make HTML files called index.html in directories"
	@echo "  singlehtml to make one big HTML file"
	@echo "  text       to make text files"
	@echo "  man        to make manual pages"
	@echo "  pickle     to make pickle files"
	@echo "  json       to make json files"
	@echo "  htmlhelp   to make HTML files and a HTML help project"
	@echo "  qthelp     to make Qt help files and project"
	@echo "  devhelp    to make Devhelp files and project"
	@echo "  epub       to make an epub file"
	@echo "  latex      to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
	@echo "  latexpdf   to make LaTeX files and run pdflatex"
	@echo "  changes    to make an overview over all changed/added/deprecated items"
	@echo "  linkcheck  to check all external links for integrity"

	-rm -rf _build/*

	$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) _build/html
	@echo "Build finished. The HTML pages are in _build/html."

	$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) _build/dirhtml
	@echo "Build finished. The HTML pages are in _build/dirhtml."

	$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) _build/singlehtml
	@echo "Build finished. The HTML page is in _build/singlehtml."

	$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) _build/text
	@echo "Build finished."

	$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) _build/man
	@echo "Build finished."

	$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) _build/pickle
	@echo "Build finished."

	$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) _build/json
	@echo "Build finished."

	$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) _build/htmlhelp
	@echo "Build finished; now you can run HTML Help Workshop with the" \
	      ".hhp project file in _build/htmlhelp."

	$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) _build/qthelp
	@echo "Build finished; now you can run qcollectiongenerator with the" \
	      ".qhcp project file in build/qthelp."
	@echo "# qcollectiongenerator _build/qthelp/Sphinx.qhcp"
	@echo "To view the help collection:"
	@echo "# assistant -collectionFile _build/qthelp/Sphinx.qhc"

	$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) _build/devhelp
	@echo "Build finished."
	@echo "To view the help file:"
	@echo "# mkdir -p $$HOME/.local/share/devhelp/sphinx"
	@echo "# ln -s _build/devhelp $$HOME/.local/share/devhelp/sphinx"
	@echo "# devhelp"

	$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) _build/epub
	@echo "Build finished. The epub file is in _build/epub."

	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) _build/latex
	@echo "Build finished; the LaTeX files are in _build/latex."
	@echo "Run \`make all-pdf' or \`make all-ps' in that directory to" \
	      "run these through (pdf)latex."

	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) _build/latex
	@echo "Running LaTeX files through pdflatex..."
	make -C _build/latex all-pdf
	@echo "pdflatex finished; the PDF files are in _build/latex."

	$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) _build/changes
	@echo "The overview file is in _build/changes."

	$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) _build/linkcheck
	@echo "Link check complete; look for any errors in the above output " \
	      "or in _build/linkcheck/output.txt."

	$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) _build/doctest
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.