Blame doc/Makefile

Pierre-Yves Chibon 300c54
# Makefile for Sphinx documentation
Pierre-Yves Chibon 300c54
#
Pierre-Yves Chibon 300c54
Pierre-Yves Chibon 300c54
# You can set these variables from the command line.
Pierre-Yves Chibon 300c54
SPHINXOPTS    =
Pierre-Yves Chibon 300c54
SPHINXBUILD   = sphinx-build
Pierre-Yves Chibon 300c54
PAPER         =
Pierre-Yves Chibon 300c54
BUILDDIR      = _build
Pierre-Yves Chibon 300c54
Pierre-Yves Chibon 300c54
# Internal variables.
Pierre-Yves Chibon 300c54
PAPEROPT_a4     = -D latex_paper_size=a4
Pierre-Yves Chibon 300c54
PAPEROPT_letter = -D latex_paper_size=letter
Pierre-Yves Chibon 300c54
ALLSPHINXOPTS   = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
Pierre-Yves Chibon 300c54
# the i18n builder cannot share the environment and doctrees with the others
Pierre-Yves Chibon 300c54
I18NSPHINXOPTS  = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
Pierre-Yves Chibon 300c54
Pierre-Yves Chibon 300c54
.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext
Pierre-Yves Chibon 300c54
Pierre-Yves Chibon 300c54
help:
Pierre-Yves Chibon 300c54
	@echo "Please use \`make <target>' where <target> is one of"</target></target>
Pierre-Yves Chibon 300c54
	@echo "  html       to make standalone HTML files"
Pierre-Yves Chibon 300c54
	@echo "  dirhtml    to make HTML files named index.html in directories"
Pierre-Yves Chibon 300c54
	@echo "  singlehtml to make a single large HTML file"
Pierre-Yves Chibon 300c54
	@echo "  pickle     to make pickle files"
Pierre-Yves Chibon 300c54
	@echo "  json       to make JSON files"
Pierre-Yves Chibon 300c54
	@echo "  htmlhelp   to make HTML files and a HTML help project"
Pierre-Yves Chibon 300c54
	@echo "  qthelp     to make HTML files and a qthelp project"
Pierre-Yves Chibon 300c54
	@echo "  devhelp    to make HTML files and a Devhelp project"
Pierre-Yves Chibon 300c54
	@echo "  epub       to make an epub"
Pierre-Yves Chibon 300c54
	@echo "  latex      to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
Pierre-Yves Chibon 300c54
	@echo "  latexpdf   to make LaTeX files and run them through pdflatex"
Pierre-Yves Chibon 300c54
	@echo "  text       to make text files"
Pierre-Yves Chibon 300c54
	@echo "  man        to make manual pages"
Pierre-Yves Chibon 300c54
	@echo "  texinfo    to make Texinfo files"
Pierre-Yves Chibon 300c54
	@echo "  info       to make Texinfo files and run them through makeinfo"
Pierre-Yves Chibon 300c54
	@echo "  gettext    to make PO message catalogs"
Pierre-Yves Chibon 300c54
	@echo "  changes    to make an overview of all changed/added/deprecated items"
Pierre-Yves Chibon 300c54
	@echo "  linkcheck  to check all external links for integrity"
Pierre-Yves Chibon 300c54
	@echo "  doctest    to run all doctests embedded in the documentation (if enabled)"
Pierre-Yves Chibon 300c54
Pierre-Yves Chibon 300c54
clean:
Pierre-Yves Chibon 300c54
	-rm -rf $(BUILDDIR)/*
Pierre-Yves Chibon 300c54
Pierre-Yves Chibon 300c54
html:
Pierre-Yves Chibon 300c54
	$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
Pierre-Yves Chibon 300c54
	@echo
Pierre-Yves Chibon 300c54
	@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
Pierre-Yves Chibon 300c54
Pierre-Yves Chibon 300c54
dirhtml:
Pierre-Yves Chibon 300c54
	$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
Pierre-Yves Chibon 300c54
	@echo
Pierre-Yves Chibon 300c54
	@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
Pierre-Yves Chibon 300c54
Pierre-Yves Chibon 300c54
singlehtml:
Pierre-Yves Chibon 300c54
	$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
Pierre-Yves Chibon 300c54
	@echo
Pierre-Yves Chibon 300c54
	@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
Pierre-Yves Chibon 300c54
Pierre-Yves Chibon 300c54
pickle:
Pierre-Yves Chibon 300c54
	$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
Pierre-Yves Chibon 300c54
	@echo
Pierre-Yves Chibon 300c54
	@echo "Build finished; now you can process the pickle files."
Pierre-Yves Chibon 300c54
Pierre-Yves Chibon 300c54
json:
Pierre-Yves Chibon 300c54
	$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
Pierre-Yves Chibon 300c54
	@echo
Pierre-Yves Chibon 300c54
	@echo "Build finished; now you can process the JSON files."
Pierre-Yves Chibon 300c54
Pierre-Yves Chibon 300c54
htmlhelp:
Pierre-Yves Chibon 300c54
	$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
Pierre-Yves Chibon 300c54
	@echo
Pierre-Yves Chibon 300c54
	@echo "Build finished; now you can run HTML Help Workshop with the" \
Pierre-Yves Chibon 300c54
	      ".hhp project file in $(BUILDDIR)/htmlhelp."
Pierre-Yves Chibon 300c54
Pierre-Yves Chibon 300c54
qthelp:
Pierre-Yves Chibon 300c54
	$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
Pierre-Yves Chibon 300c54
	@echo
Pierre-Yves Chibon 300c54
	@echo "Build finished; now you can run "qcollectiongenerator" with the" \
Pierre-Yves Chibon 300c54
	      ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
Pierre-Yves Chibon 300c54
	@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/pagure.qhcp"
Pierre-Yves Chibon 300c54
	@echo "To view the help file:"
Pierre-Yves Chibon 300c54
	@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/pagure.qhc"
Pierre-Yves Chibon 300c54
Pierre-Yves Chibon 300c54
devhelp:
Pierre-Yves Chibon 300c54
	$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
Pierre-Yves Chibon 300c54
	@echo
Pierre-Yves Chibon 300c54
	@echo "Build finished."
Pierre-Yves Chibon 300c54
	@echo "To view the help file:"
Pierre-Yves Chibon 300c54
	@echo "# mkdir -p $$HOME/.local/share/devhelp/pagure"
Pierre-Yves Chibon 300c54
	@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/pagure"
Pierre-Yves Chibon 300c54
	@echo "# devhelp"
Pierre-Yves Chibon 300c54
Pierre-Yves Chibon 300c54
epub:
Pierre-Yves Chibon 300c54
	$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
Pierre-Yves Chibon 300c54
	@echo
Pierre-Yves Chibon 300c54
	@echo "Build finished. The epub file is in $(BUILDDIR)/epub."
Pierre-Yves Chibon 300c54
Pierre-Yves Chibon 300c54
latex:
Pierre-Yves Chibon 300c54
	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
Pierre-Yves Chibon 300c54
	@echo
Pierre-Yves Chibon 300c54
	@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
Pierre-Yves Chibon 300c54
	@echo "Run \`make' in that directory to run these through (pdf)latex" \
Pierre-Yves Chibon 300c54
	      "(use \`make latexpdf' here to do that automatically)."
Pierre-Yves Chibon 300c54
Pierre-Yves Chibon 300c54
latexpdf:
Pierre-Yves Chibon 300c54
	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
Pierre-Yves Chibon 300c54
	@echo "Running LaTeX files through pdflatex..."
Pierre-Yves Chibon 300c54
	$(MAKE) -C $(BUILDDIR)/latex all-pdf
Pierre-Yves Chibon 300c54
	@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
Pierre-Yves Chibon 300c54
Pierre-Yves Chibon 300c54
text:
Pierre-Yves Chibon 300c54
	$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
Pierre-Yves Chibon 300c54
	@echo
Pierre-Yves Chibon 300c54
	@echo "Build finished. The text files are in $(BUILDDIR)/text."
Pierre-Yves Chibon 300c54
Pierre-Yves Chibon 300c54
man:
Pierre-Yves Chibon 300c54
	$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
Pierre-Yves Chibon 300c54
	@echo
Pierre-Yves Chibon 300c54
	@echo "Build finished. The manual pages are in $(BUILDDIR)/man."
Pierre-Yves Chibon 300c54
Pierre-Yves Chibon 300c54
texinfo:
Pierre-Yves Chibon 300c54
	$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
Pierre-Yves Chibon 300c54
	@echo
Pierre-Yves Chibon 300c54
	@echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
Pierre-Yves Chibon 300c54
	@echo "Run \`make' in that directory to run these through makeinfo" \
Pierre-Yves Chibon 300c54
	      "(use \`make info' here to do that automatically)."
Pierre-Yves Chibon 300c54
Pierre-Yves Chibon 300c54
info:
Pierre-Yves Chibon 300c54
	$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
Pierre-Yves Chibon 300c54
	@echo "Running Texinfo files through makeinfo..."
Pierre-Yves Chibon 300c54
	make -C $(BUILDDIR)/texinfo info
Pierre-Yves Chibon 300c54
	@echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
Pierre-Yves Chibon 300c54
Pierre-Yves Chibon 300c54
gettext:
Pierre-Yves Chibon 300c54
	$(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
Pierre-Yves Chibon 300c54
	@echo
Pierre-Yves Chibon 300c54
	@echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
Pierre-Yves Chibon 300c54
Pierre-Yves Chibon 300c54
changes:
Pierre-Yves Chibon 300c54
	$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
Pierre-Yves Chibon 300c54
	@echo
Pierre-Yves Chibon 300c54
	@echo "The overview file is in $(BUILDDIR)/changes."
Pierre-Yves Chibon 300c54
Pierre-Yves Chibon 300c54
linkcheck:
Pierre-Yves Chibon 300c54
	$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
Pierre-Yves Chibon 300c54
	@echo
Pierre-Yves Chibon 300c54
	@echo "Link check complete; look for any errors in the above output " \
Pierre-Yves Chibon 300c54
	      "or in $(BUILDDIR)/linkcheck/output.txt."
Pierre-Yves Chibon 300c54
Pierre-Yves Chibon 300c54
doctest:
Pierre-Yves Chibon 300c54
	$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
Pierre-Yves Chibon 300c54
	@echo "Testing of doctests in the sources finished, look at the " \
Pierre-Yves Chibon 300c54
	      "results in $(BUILDDIR)/doctest/output.txt."