Geografic-Information-System/gui/wxpython/docs/wxgui_toolboxes/Makefile

# Makefile for Sphinx documentation
#
MODULE_TOPDIR=../../../..
include $(MODULE_TOPDIR)/include/Make/Vars.make
include $(MODULE_TOPDIR)/include/Make/Rules.make


PAPER         =
BUILDDIR      = _build
BUILDDIR_HTML = $(HTMLDIR)/wxgui_toolboxes

MYGISBASE = $(GISBASE)

# Internal variables.
PAPEROPT_a4     = -D latex_paper_size=a4
PAPEROPT_letter = -D latex_paper_size=letter
ALLSPHINXOPTS   = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) -c . src/
# the i18n builder cannot share the environment and doctrees with the others
I18NSPHINXOPTS  = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
SPHINXBUILD     = sphinx-build
SPHINXAPIDOC    = sphinx-apidoc

# some distros come with a different name
BUILD  := $(type $(SPHINXBUILD) >/dev/null)  || (SPHINXBUILD  = sphinx-build2)
APIDOC := $(type $(SPHINXAPIDOC) >/dev/null) || (SPHINXAPIDOC = sphinx-apidoc2)

checksphinx:
	@echo "SPHINXBUILD: Found <$(SPHINXBUILD)>"
	@echo "SPHINXAPIDOC: Found <$(SPHINXAPIDOC)>"
	@(type $(SPHINXBUILD) > /dev/null || (echo "ERROR: Install 'sphinx-build' software first (get from http://sphinx-doc.org)" && exit 1))
	@(type $(SPHINXAPIDOC) > /dev/null || (echo "ERROR: Install 'sphinx-apidoc' software first (get from http://sphinx-doc.org)" && exit 1))

.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp checksphinx libpythonapidoc libpythonclean libpythondirhtml libpythondoctest libpythonepub libpythonhelp libpythonhtml libpythonlatex libpythonlatexpdf libpythonman libpythonsinglehtml

.DEFAULT_GOAL := toolboxeshelp

toolboxeshelp:
	@echo "Please use \`make <target>' where <target> is one of"
	@echo "  toolboxeshtml       to make standalone HTML files"
	@echo "  toolboxesdirhtml    to make HTML files named index.html in directories"
	@echo "  toolboxessinglehtml to make a single large HTML file"
	@echo "  toolboxesepub       to make an epub"
	@echo "  toolboxeslatex      to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
	@echo "  toolboxeslatexpdf   to make LaTeX files and run them through pdflatex"
	@echo "  toolboxesman        to make manual pages"
	@echo "  toolboxesdoctest    to run all doctests embedded in the documentation (if enabled)"

toolboxesclean:
	-rm -rf $(BUILDDIR)
	-rm -f _templates/layout.html

toolboxesapidoc:
	@echo "SPHINXBUILD: Using <$(SPHINXBUILD)>"
	$(call run_grass,$(SPHINXAPIDOC) -T -f -o src/ ../../core/)
	
toolboxeshtml:
	@echo "SPHINXBUILD: Using <$(SPHINXBUILD)>"
	$(call run_grass,$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR_HTML))
	@echo
	@echo "Build finished. The HTML pages are in $(BUILDDIR_HTML)"

toolboxesdirhtml:
	@echo "SPHINXBUILD: Using <$(SPHINXBUILD)>"
	$(call run_grass,$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR_HTML))
	@echo
	@echo "Build finished. The HTML pages are in $(BUILDDIR_HTML)"

toolboxessinglehtml:
	@echo "SPHINXBUILD: Using <$(SPHINXBUILD)>"
	$(call run_grass,$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR_HTML))
	@echo
	@echo "Build finished. The HTML page is in $(BUILDDIR_HTML)"

toolboxesepub:
	@echo "SPHINXBUILD: Using <$(SPHINXBUILD)>"
	$(call run_grass,$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub)
	@echo
	@echo "Build finished. The epub file is in $(BUILDDIR)/epub/"

toolboxeslatex:
	@echo "SPHINXBUILD: Using <$(SPHINXBUILD)>"
	$(call run_grass,$(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)."

toolboxeslatexpdf:
	@echo "SPHINXBUILD: Using <$(SPHINXBUILD)>"
	$(call run_grass,$(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/"

toolboxesman:
	@echo "SPHINXBUILD: Using <$(SPHINXBUILD)>"
	$(call run_grass,$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(MANDIR))
	@echo
	@echo "Build finished. The manual pages are in $(MANDIR)/"

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

clean: toolboxesclean