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