emory-libraries/eulexistdb

# Makefile for EULexistdb Sphinx-based documentation
#

export PYTHONPATH=.:..
# sphinx needs django settings while loading django helpers to introspect
# those modules for autodocs
export DJANGO_SETTINGS_MODULE=doc_djangosettings

SPHINXOPTS    =
SPHINXBUILD   = sphinx-build
PAPER         =

PAPEROPT_a4     = -D latex_paper_size=a4
PAPEROPT_letter = -D latex_paper_size=letter
ALLSPHINXOPTS   = -d build/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .

.PHONY: help all clean html web pickle htmlhelp latex changes linkcheck

help:
    @echo "Please use \`make <target>' where <target> is one of"
    @echo "  html      to make standalone HTML files"
    @echo "  pickle    to make pickle files"
    @echo "  json      to make JSON files"
    @echo "  htmlhelp  to make HTML files and a HTML help project"
    @echo "  latex     to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
    @echo "  changes   to make an overview over all changed/added/deprecated items"
    @echo "  linkcheck to check all external links for integrity"

all: html

clean:
    -rm -rf build *.pyc

html:
    mkdir -p build/html build/doctrees
    $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) build/html
    @echo
    @echo "Build finished. The HTML pages are in build/html."

pickle:
    mkdir -p build/pickle build/doctrees
    $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) build/pickle
    @echo
    @echo "Build finished; now you can process the pickle files."

web: pickle

json:
    mkdir -p build/json build/doctrees
    $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) build/json
    @echo
    @echo "Build finished; now you can process the JSON files."

htmlhelp:
    mkdir -p build/htmlhelp build/doctrees
    $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) build/htmlhelp
    @echo
    @echo "Build finished; now you can run HTML Help Workshop with the" \
          ".hhp project file in build/htmlhelp."

latex:
    mkdir -p build/latex build/doctrees
    $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) build/latex
    @echo
    @echo "Build finished; the LaTeX files are in build/latex."
    @echo "Run \`make all-pdf' or \`make all-ps' in that directory to" \
          "run these through (pdf)latex."

changes:
    mkdir -p build/changes build/doctrees
    $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) build/changes
    @echo
    @echo "The overview file is in build/changes."

linkcheck:
    mkdir -p build/linkcheck build/doctrees
    $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) build/linkcheck
    @echo
    @echo "Link check complete; look for any errors in the above output " \
          "or in build/linkcheck/output.txt."