# Makefile for Sphinx documentation
#

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

# Internal variables.
PAPEROPT_a4     = -D latex_paper_size=a4
PAPEROPT_letter = -D latex_paper_size=letter
ALLSPHINXOPTS   = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
VERSION			= `python -c "import globus.provision; print globus.provision.RELEASE"`

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

help:
	@echo "Please use \`make <target>' where <target> is one of"
	@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)/* *_ref.rst	

cli_ref.rst: ../src/globus/provision/cli/api.py
	python gen_cli_doc.py > cli_ref.rst

config_ref.rst: ../src/globus/provision/core/config.py
	python gen_config_doc.py GPConfig "Configuration file" > config_ref.rst

stopology_ref.rst: ../src/globus/provision/core/config.py
	python gen_config_doc.py SimpleTopologyConfig "Simple topology" > stopology_ref.rst

topology_ref.rst: ../src/globus/provision/core/topology.py
	python gen_topology_doc.py > topology_ref.rst
	
recipe_ref.rst: 
	python gen_recipe_doc.py > recipe_ref.rst

autogenerated: cli_ref.rst config_ref.rst stopology_ref.rst topology_ref.rst recipe_ref.rst

website_full: singlehtml html latexpdf
	mkdir -p $(BUILDDIR)/web-$(VERSION)

	cp -r $(BUILDDIR)/singlehtml $(BUILDDIR)/web-$(VERSION)/ 

	tar czf $(BUILDDIR)/web-$(VERSION)/globus-provision-docs-singlehtml_$(VERSION).tar.gz -C $(BUILDDIR) singlehtml
	zip -r $(BUILDDIR)/web-$(VERSION)/globus-provision-docs-singlehtml_$(VERSION).zip $(BUILDDIR)/singlehtml

	tar czf $(BUILDDIR)/web-$(VERSION)/globus-provision-docs-html_$(VERSION).tar.gz -C $(BUILDDIR) html
	zip -r $(BUILDDIR)/web-$(VERSION)/globus-provision-docs-html_$(VERSION).zip $(BUILDDIR)/html

	tar czf $(BUILDDIR)/web-$(VERSION)/globus-provision-docs-samples_$(VERSION).tar.gz -C ../ samples
	zip -r $(BUILDDIR)/web-$(VERSION)/globus-provision-docs-samples_$(VERSION).zip ../samples/

	cp $(BUILDDIR)/latex/GlobusProvision.pdf $(BUILDDIR)/web-$(VERSION)/globus-provision-docs-pdf_$(VERSION).pdf 

	$(SPHINXBUILD) -b html -Dwebsite=yes -Dmaster_doc=index $(ALLSPHINXOPTS) $(BUILDDIR)/web-$(VERSION)
	@echo
	@echo "Build finished. The HTML pages are in $(BUILDDIR)/web."

website: autogenerated
	$(SPHINXBUILD) -b html -Dwebsite=yes -Dmaster_doc=index $(ALLSPHINXOPTS) $(BUILDDIR)/web
	@echo
	@echo "Build finished. The HTML pages are in $(BUILDDIR)/web."
	
html: autogenerated
	$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
	@echo
	@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."	

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

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

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

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

htmlhelp:
	$(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:
	$(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/GlobusProvision.qhcp"
	@echo "To view the help file:"
	@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/GlobusProvision.qhc"

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

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

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

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