1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125
|
# 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."
|