/doc/Makefile
https://gitlab.com/vote539/ase · Makefile · 49 lines · 34 code · 9 blank · 6 comment · 2 complexity · 2cbadb42c2c502add66214a68f232fa7 MD5 · raw file
- # Makefile for Sphinx documentation
- #
- # You can set these variables from the command line.
- SPHINXOPTS =
- SPHINXBUILD = sphinx-build
- PAPER =
- BUILDDIR = build
- # User-friendly check for sphinx-build
- ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1)
- $(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/)
- endif
- # Internal variables.
- PAPEROPT_a4 = -D latex_paper_size=a4
- PAPEROPT_letter = -D latex_paper_size=letter
- ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
- # the i18n builder cannot share the environment and doctrees with the others
- I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
- .PHONY: help clean html latex linkcheck
- html:
- $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
- @echo
- @echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
- help:
- @echo "Use \`make <target>' where <target> is one of"
- @echo " html to make standalone HTML files"
- @echo " latexpdf to make LaTeX files and run them through pdflatex"
- @echo " linkcheck to check all external links for integrity"
- @echo " clean to clean up"
- latex:
- $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
- @echo "Running LaTeX files through pdflatex..."
- $(MAKE) -C $(BUILDDIR)/latex all-pdf
- @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
- clean:
- rm -rf $(BUILDDIR)/*
- linkcheck:
- $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
- @echo
- @echo "Link check complete; look for any errors in the above output " \
- "or in $(BUILDDIR)/linkcheck/output.txt."