Blame docs/Makefile

Packit Service e08953
# Makefile for Sphinx documentation
Packit Service e08953
#
Packit Service e08953
Packit Service e08953
# You can set these variables from the command line.
Packit Service e08953
SPHINXOPTS      =
Packit Service e08953
SPHINXBUILD     = sphinx-build
Packit Service e08953
SPHINXAUTOBUILD = sphinx-autobuild
Packit Service e08953
PAPER           =
Packit Service e08953
BUILDDIR        = build
Packit Service e08953
SRCDIR          = src
Packit Service e08953
Packit Service e08953
# User-friendly check for sphinx-build
Packit Service e08953
ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1)
Packit Service e08953
$(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/)
Packit Service e08953
endif
Packit Service e08953
Packit Service e08953
# Internal variables.
Packit Service e08953
PAPEROPT_a4     = -D latex_paper_size=a4
Packit Service e08953
PAPEROPT_letter = -D latex_paper_size=letter
Packit Service e08953
ALLSPHINXOPTS   = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) $(SRCDIR)
Packit Service e08953
# the i18n builder cannot share the environment and doctrees with the others
Packit Service e08953
I18NSPHINXOPTS  = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) $(SRCDIR)
Packit Service e08953
Packit Service e08953
.PHONY: help clean html livehtml dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext
Packit Service e08953
Packit Service e08953
help:
Packit Service e08953
	@echo "Please use \`make <target>' where <target> is one of"
Packit Service e08953
	@echo "  html       to make standalone HTML files"
Packit Service e08953
	@echo "  livehtml   to make standalone HTML files and live reload them"
Packit Service e08953
	@echo "  dirhtml    to make HTML files named index.html in directories"
Packit Service e08953
	@echo "  singlehtml to make a single large HTML file"
Packit Service e08953
	@echo "  pickle     to make pickle files"
Packit Service e08953
	@echo "  json       to make JSON files"
Packit Service e08953
	@echo "  htmlhelp   to make HTML files and a HTML help project"
Packit Service e08953
	@echo "  qthelp     to make HTML files and a qthelp project"
Packit Service e08953
	@echo "  devhelp    to make HTML files and a Devhelp project"
Packit Service e08953
	@echo "  epub       to make an epub"
Packit Service e08953
	@echo "  latex      to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
Packit Service e08953
	@echo "  latexpdf   to make LaTeX files and run them through pdflatex"
Packit Service e08953
	@echo "  latexpdfja to make LaTeX files and run them through platex/dvipdfmx"
Packit Service e08953
	@echo "  text       to make text files"
Packit Service e08953
	@echo "  man        to make manual pages"
Packit Service e08953
	@echo "  texinfo    to make Texinfo files"
Packit Service e08953
	@echo "  info       to make Texinfo files and run them through makeinfo"
Packit Service e08953
	@echo "  gettext    to make PO message catalogs"
Packit Service e08953
	@echo "  changes    to make an overview of all changed/added/deprecated items"
Packit Service e08953
	@echo "  xml        to make Docutils-native XML files"
Packit Service e08953
	@echo "  pseudoxml  to make pseudoxml-XML files for display purposes"
Packit Service e08953
	@echo "  linkcheck  to check all external links for integrity"
Packit Service e08953
	@echo "  doctest    to run all doctests embedded in the documentation (if enabled)"
Packit Service e08953
Packit Service e08953
clean:
Packit Service e08953
	rm -rf $(BUILDDIR)/*
Packit Service e08953
Packit Service e08953
html:
Packit Service e08953
	$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
Packit Service e08953
	@echo
Packit Service e08953
	@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
Packit Service e08953
Packit Service e08953
livehtml: html
Packit Service e08953
	$(SPHINXAUTOBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
Packit Service e08953
Packit Service e08953
dirhtml:
Packit Service e08953
	$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
Packit Service e08953
	@echo
Packit Service e08953
	@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
Packit Service e08953
Packit Service e08953
singlehtml:
Packit Service e08953
	$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
Packit Service e08953
	@echo
Packit Service e08953
	@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
Packit Service e08953
Packit Service e08953
pickle:
Packit Service e08953
	$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
Packit Service e08953
	@echo
Packit Service e08953
	@echo "Build finished; now you can process the pickle files."
Packit Service e08953
Packit Service e08953
json:
Packit Service e08953
	$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
Packit Service e08953
	@echo
Packit Service e08953
	@echo "Build finished; now you can process the JSON files."
Packit Service e08953
Packit Service e08953
htmlhelp:
Packit Service e08953
	$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
Packit Service e08953
	@echo
Packit Service e08953
	@echo "Build finished; now you can run HTML Help Workshop with the" \
Packit Service e08953
	      ".hhp project file in $(BUILDDIR)/htmlhelp."
Packit Service e08953
Packit Service e08953
qthelp:
Packit Service e08953
	$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
Packit Service e08953
	@echo
Packit Service e08953
	@echo "Build finished; now you can run "qcollectiongenerator" with the" \
Packit Service e08953
	      ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
Packit Service e08953
	@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/libuv.qhcp"
Packit Service e08953
	@echo "To view the help file:"
Packit Service e08953
	@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/libuv.qhc"
Packit Service e08953
Packit Service e08953
devhelp:
Packit Service e08953
	$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
Packit Service e08953
	@echo
Packit Service e08953
	@echo "Build finished."
Packit Service e08953
	@echo "To view the help file:"
Packit Service e08953
	@echo "# mkdir -p $$HOME/.local/share/devhelp/libuv"
Packit Service e08953
	@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/libuv"
Packit Service e08953
	@echo "# devhelp"
Packit Service e08953
Packit Service e08953
epub:
Packit Service e08953
	$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
Packit Service e08953
	@echo
Packit Service e08953
	@echo "Build finished. The epub file is in $(BUILDDIR)/epub."
Packit Service e08953
Packit Service e08953
latex:
Packit Service e08953
	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
Packit Service e08953
	@echo
Packit Service e08953
	@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
Packit Service e08953
	@echo "Run \`make' in that directory to run these through (pdf)latex" \
Packit Service e08953
	      "(use \`make latexpdf' here to do that automatically)."
Packit Service e08953
Packit Service e08953
latexpdf:
Packit Service e08953
	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
Packit Service e08953
	@echo "Running LaTeX files through pdflatex..."
Packit Service e08953
	$(MAKE) -C $(BUILDDIR)/latex all-pdf
Packit Service e08953
	@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
Packit Service e08953
Packit Service e08953
latexpdfja:
Packit Service e08953
	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
Packit Service e08953
	@echo "Running LaTeX files through platex and dvipdfmx..."
Packit Service e08953
	$(MAKE) -C $(BUILDDIR)/latex all-pdf-ja
Packit Service e08953
	@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
Packit Service e08953
Packit Service e08953
text:
Packit Service e08953
	$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
Packit Service e08953
	@echo
Packit Service e08953
	@echo "Build finished. The text files are in $(BUILDDIR)/text."
Packit Service e08953
Packit Service e08953
man:
Packit Service e08953
	$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
Packit Service e08953
	@echo
Packit Service e08953
	@echo "Build finished. The manual pages are in $(BUILDDIR)/man."
Packit Service e08953
Packit Service e08953
texinfo:
Packit Service e08953
	$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
Packit Service e08953
	@echo
Packit Service e08953
	@echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
Packit Service e08953
	@echo "Run \`make' in that directory to run these through makeinfo" \
Packit Service e08953
	      "(use \`make info' here to do that automatically)."
Packit Service e08953
Packit Service e08953
info:
Packit Service e08953
	$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
Packit Service e08953
	@echo "Running Texinfo files through makeinfo..."
Packit Service e08953
	make -C $(BUILDDIR)/texinfo info
Packit Service e08953
	@echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
Packit Service e08953
Packit Service e08953
gettext:
Packit Service e08953
	$(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
Packit Service e08953
	@echo
Packit Service e08953
	@echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
Packit Service e08953
Packit Service e08953
changes:
Packit Service e08953
	$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
Packit Service e08953
	@echo
Packit Service e08953
	@echo "The overview file is in $(BUILDDIR)/changes."
Packit Service e08953
Packit Service e08953
linkcheck:
Packit Service e08953
	$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
Packit Service e08953
	@echo
Packit Service e08953
	@echo "Link check complete; look for any errors in the above output " \
Packit Service e08953
	      "or in $(BUILDDIR)/linkcheck/output.txt."
Packit Service e08953
Packit Service e08953
doctest:
Packit Service e08953
	$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
Packit Service e08953
	@echo "Testing of doctests in the sources finished, look at the " \
Packit Service e08953
	      "results in $(BUILDDIR)/doctest/output.txt."
Packit Service e08953
Packit Service e08953
xml:
Packit Service e08953
	$(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml
Packit Service e08953
	@echo
Packit Service e08953
	@echo "Build finished. The XML files are in $(BUILDDIR)/xml."
Packit Service e08953
Packit Service e08953
pseudoxml:
Packit Service e08953
	$(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml
Packit Service e08953
	@echo
Packit Service e08953
	@echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml."