0001
0002
0003
0004
0005 SPHINXOPTS ?=
0006 SPHINXBUILD ?= sphinx-build
0007 PAPER ?=
0008 BUILDDIR ?= _build
0009
0010 export PYTHONPATH=$(realpath ..):$(realpath ../lib/py4j-0.10.9-src.zip)
0011
0012
0013 ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1)
0014 $(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/)
0015 endif
0016
0017 # Internal variables.
0018 PAPEROPT_a4 = -D latex_paper_size=a4
0019 PAPEROPT_letter = -D latex_paper_size=letter
0020 ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
0021 # the i18n builder cannot share the environment and doctrees with the others
0022 I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
0023
0024 .PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext
0025
0026 help:
0027 @echo "Please use \`make <target>' where <target> is one of"
0028 @echo " html to make standalone HTML files"
0029 @echo " dirhtml to make HTML files named index.html in directories"
0030 @echo " singlehtml to make a single large HTML file"
0031 @echo " pickle to make pickle files"
0032 @echo " json to make JSON files"
0033 @echo " htmlhelp to make HTML files and a HTML help project"
0034 @echo " qthelp to make HTML files and a qthelp project"
0035 @echo " devhelp to make HTML files and a Devhelp project"
0036 @echo " epub to make an epub"
0037 @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
0038 @echo " latexpdf to make LaTeX files and run them through pdflatex"
0039 @echo " latexpdfja to make LaTeX files and run them through platex/dvipdfmx"
0040 @echo " text to make text files"
0041 @echo " man to make manual pages"
0042 @echo " texinfo to make Texinfo files"
0043 @echo " info to make Texinfo files and run them through makeinfo"
0044 @echo " gettext to make PO message catalogs"
0045 @echo " changes to make an overview of all changed/added/deprecated items"
0046 @echo " xml to make Docutils-native XML files"
0047 @echo " pseudoxml to make pseudoxml-XML files for display purposes"
0048 @echo " linkcheck to check all external links for integrity"
0049 @echo " doctest to run all doctests embedded in the documentation (if enabled)"
0050
0051 clean:
0052 rm -rf $(BUILDDIR)/*
0053
0054 html:
0055 $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
0056 @echo
0057 @echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
0058
0059 dirhtml:
0060 $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
0061 @echo
0062 @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
0063
0064 singlehtml:
0065 $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
0066 @echo
0067 @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
0068
0069 pickle:
0070 $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
0071 @echo
0072 @echo "Build finished; now you can process the pickle files."
0073
0074 json:
0075 $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
0076 @echo
0077 @echo "Build finished; now you can process the JSON files."
0078
0079 htmlhelp:
0080 $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
0081 @echo
0082 @echo "Build finished; now you can run HTML Help Workshop with the" \
0083 ".hhp project file in $(BUILDDIR)/htmlhelp."
0084
0085 qthelp:
0086 $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
0087 @echo
0088 @echo "Build finished; now you can run "qcollectiongenerator" with the" \
0089 ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
0090 @echo "
0091 @echo "To view the help file:"
0092 @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/pyspark.qhc"
0093
0094 devhelp:
0095 $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
0096 @echo
0097 @echo "Build finished."
0098 @echo "To view the help file:"
0099 @echo "# mkdir -p $$HOME/.local/share/devhelp/pyspark"
0100 @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/pyspark"
0101 @echo "# devhelp"
0102
0103 epub:
0104 $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
0105 @echo
0106 @echo "Build finished. The epub file is in $(BUILDDIR)/epub."
0107
0108 latex:
0109 $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
0110 @echo
0111 @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
0112 @echo "Run \`make' in that directory to run these through (pdf)latex" \
0113 "(use \`make latexpdf' here to do that automatically)."
0114
0115 latexpdf:
0116 $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
0117 @echo "Running LaTeX files through pdflatex..."
0118 $(MAKE) -C $(BUILDDIR)/latex all-pdf
0119 @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
0120
0121 latexpdfja:
0122 $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
0123 @echo "Running LaTeX files through platex and dvipdfmx..."
0124 $(MAKE) -C $(BUILDDIR)/latex all-pdf-ja
0125 @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
0126
0127 text:
0128 $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
0129 @echo
0130 @echo "Build finished. The text files are in $(BUILDDIR)/text."
0131
0132 man:
0133 $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
0134 @echo
0135 @echo "Build finished. The manual pages are in $(BUILDDIR)/man."
0136
0137 texinfo:
0138 $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
0139 @echo
0140 @echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
0141 @echo "Run \`make' in that directory to run these through makeinfo" \
0142 "(use \`make info' here to do that automatically)."
0143
0144 info:
0145 $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
0146 @echo "Running Texinfo files through makeinfo..."
0147 make -C $(BUILDDIR)/texinfo info
0148 @echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
0149
0150 gettext:
0151 $(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
0152 @echo
0153 @echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
0154
0155 changes:
0156 $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
0157 @echo
0158 @echo "The overview file is in $(BUILDDIR)/changes."
0159
0160 linkcheck:
0161 $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
0162 @echo
0163 @echo "Link check complete; look for any errors in the above output " \
0164 "or in $(BUILDDIR)/linkcheck/output.txt."
0165
0166 doctest:
0167 $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
0168 @echo "Testing of doctests in the sources finished, look at the " \
0169 "results in $(BUILDDIR)/doctest/output.txt."
0170
0171 xml:
0172 $(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml
0173 @echo
0174 @echo "Build finished. The XML files are in $(BUILDDIR)/xml."
0175
0176 pseudoxml:
0177 $(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml
0178 @echo
0179 @echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml."
