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

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

# You can set these variables from the command line.
SPHINXOPTS    =

APIDOC := $(shell which sphinx-apidoc2)
ifdef APIDOC
SPHINXAPIDOC = sphinx-apidoc2
else
APIDOC := $(shell which sphinx-apidoc)
ifdef APIDOC
SPHINXAPIDOC = sphinx-apidoc
endif
endif

BUILD := $(shell which sphinx-build2)
ifdef BUILD
SPHINXBUILD = sphinx-build2
else
BUILD := $(shell which sphinx-build)
ifdef BUILD
SPHINXBUILD = sphinx-build
endif
endif

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

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

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

.DEFAULT_GOAL := help


wxguihelp:
	@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 "  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 "  man        to make manual pages"
	@echo "  doctest    to run all doctests embedded in the documentation (if enabled)"

wxguiclean:
	-rm -rf $(BUILDDIR)/*
	-rm -rf src/a*.rst
	-rm -rf src/c*.rst
	-rm -rf src/d*.rst
	-rm -rf src/g*.rst
	-rm -rf src/ic*.rst
	-rm -rf src/is*.rst
	-rm -rf src/l*.rst
	-rm -rf src/m*.rst
	-rm -rf src/n*.rst
	-rm -rf src/p*.rst
	-rm -rf src/r*.rst
	-rm -rf src/t*.rst
	-rm -rf src/v*.rst
	-rm -rf src/web_services.rst
	-rm -rf src/wxgui.rst
	-rm -rf src/wxplot.rst
	-rm -f _templates/layout.html

wxguiapidoc:
	@echo $(SPHINXAPIDOC)
	@echo $(SPHINXBUILD)
	$(call run_grass,$(SPHINXAPIDOC) -T -f -o src/ ../../ ../../*/g.gui.*.py)

wxguihtml:
	$(call run_grass,$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR_HTML))
	@echo
	@echo "Build finished. The HTML pages are in $(BUILDDIR_HTML)"

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

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

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

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

wxguilatexpdf:
	$(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/"

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

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