# Makefile for Albatross documentation (ReST, Sphinx)
#

# You can set these variables from the command line.
SPHINXOPTS    =
SPHINXBUILD   = sphinx-build
PAPER         =
BUILDDIR      = .build
PYTHON        = python

# Internal variables.
PAPEROPT_a4     = -D latex_paper_size=a4
PAPEROPT_letter = -D latex_paper_size=letter
ALLSPHINXOPTS   = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .

.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest

FIGURES = simplecontext.dia simpleappcontext.dia simpleapp.dia \
	twolayer.dia twolayerctx.dia mvc.dia albmvc.dia pagemap.dia \
	toolkit.dia appcontext.dia application.dia sessionappcontext.dia \
	sessionfileappcontext.dia simplesessapp.dia simplesessfileapp.dia \
	modularapp.dia modularsessapp.dia modularsessfileapp.dia \
	dataflow.dia AlbatrossObjects.dia randmodapp.dia randmodsessapp.dia \
	randmodsessfileapp.dia branchingsessioncontext.dia

METHODS = SimpleContext AppContext SimpleAppContext SessionAppContext \
	SessionFileAppContext Application SimpleApp SimpleSessionApp \
	SimpleSessionFileApp ModularApp ModularSessionApp \
	ModularSessionFileApp RandomModularApp RandomModularSessionApp \
	RandomModularSessionFileApp BranchingSessionContext

METHODFILES = $(addprefix $(BUILDDIR)/method-docs/,$(addsuffix -methods.rst,$(METHODS)))
PNGFIGURES = $(addprefix $(BUILDDIR)/figures/,$(addsuffix .png,$(basename $(FIGURES))))
PDFFIGURES = $(addprefix $(BUILDDIR)/figures/,$(addsuffix .pdf,$(basename $(FIGURES))))

help:
	@echo "Please use \`make <target>' where <target> is one of"
	@echo "  test       to test examples within documentation (Albatross specific)"
	@echo "  html       to make standalone HTML files"
	@echo "  dirhtml    to make HTML files named index.html in directories"
	@echo "  singlehtml to make a single large HTML file"
	@echo "  pickle     to make pickle files"
	@echo "  json       to make JSON files"
	@echo "  htmlhelp   to make HTML files and a HTML help project"
	@echo "  qthelp     to make HTML files and a qthelp project"
	@echo "  devhelp    to make HTML files and a Devhelp project"
	@echo "  epub       to make an epub"
	@echo "  latex      to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
	@echo "  latexpdf   to make LaTeX files and run them through pdflatex"
	@echo "  text       to make text files"
	@echo "  man        to make manual pages"
	@echo "  changes    to make an overview of all changed/added/deprecated items"
	@echo "  linkcheck  to check all external links for integrity"
	@echo "  doctest    to run all doctests embedded in the documentation (if enabled)"

clean:
	-rm -rf $(BUILDDIR)/*

test:
	PYTHONPATH=.. $(PYTHON) ../test/doc_examples.py

html: $(PNGFIGURES) $(METHODFILES)
	$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
	@ln -sf $(BUILDDIR)/html .
	@echo
	@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."

dirhtml: $(PNGFIGURES) $(METHODFILES)
	$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
	@echo
	@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."

singlehtml: $(PNGFIGURES) $(METHODFILES)
	$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
	@echo
	@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."

pickle: $(PNGFIGURES) $(METHODFILES)
	$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
	@echo
	@echo "Build finished; now you can process the pickle files."

json: $(PNGFIGURES) $(METHODFILES)
	$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
	@echo
	@echo "Build finished; now you can process the JSON files."

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

qthelp: $(PNGFIGURES) $(METHODFILES)
	$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
	@echo
	@echo "Build finished; now you can run "qcollectiongenerator" with the" \
	      ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
	@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/Albatross.qhcp"
	@echo "To view the help file:"
	@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/Albatross.qhc"

devhelp: $(PNGFIGURES) $(METHODFILES)
	$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
	@echo
	@echo "Build finished."
	@echo "To view the help file:"
	@echo "# mkdir -p $$HOME/.local/share/devhelp/Albatross"
	@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/Albatross"
	@echo "# devhelp"

epub: $(PNGFIGURES) $(METHODFILES)
	$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
	@echo
	@echo "Build finished. The epub file is in $(BUILDDIR)/epub."

latex: $(PDFFIGURES) $(METHODFILES)
	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
	@echo
	@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
	@echo "Run \`make' in that directory to run these through (pdf)latex" \
	      "(use \`make latexpdf' here to do that automatically)."

latexpdf:
	$(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."

text:
	$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
	@echo
	@echo "Build finished. The text files are in $(BUILDDIR)/text."

man:
	$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
	@echo
	@echo "Build finished. The manual pages are in $(BUILDDIR)/man."

pdf: latex
	(cd $(BUILDDIR)/latex \
		&& pdflatex Albatross.tex \
		&& makeindex -s python.ist Albatross.idx \
		&& pdflatex Albatross.tex \
		&& mv Albatross.pdf ../..)

changes:
	$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
	@echo
	@echo "The overview file is in $(BUILDDIR)/changes."

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."

doctest:
	$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
	@echo "Testing of doctests in the sources finished, look at the " \
	      "results in $(BUILDDIR)/doctest/output.txt."

$(METHODFILES): ../albatross/*.py
	@mkdir -p $(BUILDDIR)/method-docs
	$(PYTHON) scripts/doc_methods.py -o $@ \
		albatross.$(subst -methods.rst,,$(notdir $@))

$(BUILDDIR)/figures/%.png: figures/%.dia
	@mkdir -p $(BUILDDIR)/figures
	dia --nosplash --export=$(addprefix $(BUILDDIR)/,$(subst .dia,.png,$<)) --size=800 $<

$(BUILDDIR)/figures/%.pdf: figures/%.dia
	@mkdir -p $(BUILDDIR)/figures
	dia --nosplash --filter=eps-builtin --export=$(addprefix $(BUILDDIR)/,$(subst .dia,.eps,$<)) $<
	epstopdf $(addprefix $(BUILDDIR)/,$(subst .dia,.eps,$<))
	rm $(addprefix $(BUILDDIR)/,$(subst .dia,.eps,$<))
