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