File indexing completed on 2025-02-23 04:13:23
0001 # Makefile for Sphinx documentation 0002 # 0003 0004 # You can set these variables from the command line. 0005 SPHINXOPTS = 0006 SPHINXBUILD = sphinx-build 0007 PAPER = 0008 BUILDDIR = _build 0009 0010 # Internal variables. 0011 PAPEROPT_a4 = -D latex_paper_size=a4 0012 PAPEROPT_letter = -D latex_paper_size=letter 0013 ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . 0014 0015 .PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest 0016 0017 help: 0018 @echo "Please use \`make <target>' where <target> is one of" 0019 @echo " html to make standalone HTML files" 0020 @echo " dirhtml to make HTML files named index.html in directories" 0021 @echo " singlehtml to make a single large HTML file" 0022 @echo " pickle to make pickle files" 0023 @echo " json to make JSON files" 0024 @echo " htmlhelp to make HTML files and a HTML help project" 0025 @echo " qthelp to make HTML files and a qthelp project" 0026 @echo " devhelp to make HTML files and a Devhelp project" 0027 @echo " epub to make an epub" 0028 @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter" 0029 @echo " latexpdf to make LaTeX files and run them through pdflatex" 0030 @echo " text to make text files" 0031 @echo " man to make manual pages" 0032 @echo " changes to make an overview of all changed/added/deprecated items" 0033 @echo " linkcheck to check all external links for integrity" 0034 @echo " doctest to run all doctests embedded in the documentation (if enabled)" 0035 0036 clean: 0037 -rm -rf $(BUILDDIR)/* 0038 0039 html: 0040 $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html 0041 @echo 0042 @echo "Build finished. The HTML pages are in $(BUILDDIR)/html." 0043 0044 dirhtml: 0045 $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml 0046 @echo 0047 @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml." 0048 0049 singlehtml: 0050 $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml 0051 @echo 0052 @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml." 0053 0054 pickle: 0055 $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle 0056 @echo 0057 @echo "Build finished; now you can process the pickle files." 0058 0059 json: 0060 $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json 0061 @echo 0062 @echo "Build finished; now you can process the JSON files." 0063 0064 htmlhelp: 0065 $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp 0066 @echo 0067 @echo "Build finished; now you can run HTML Help Workshop with the" \ 0068 ".hhp project file in $(BUILDDIR)/htmlhelp." 0069 0070 qthelp: 0071 $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp 0072 @echo 0073 @echo "Build finished; now you can run "qcollectiongenerator" with the" \ 0074 ".qhcp project file in $(BUILDDIR)/qthelp, like this:" 0075 @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/pykst.qhcp" 0076 @echo "To view the help file:" 0077 @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/pykst.qhc" 0078 0079 devhelp: 0080 $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp 0081 @echo 0082 @echo "Build finished." 0083 @echo "To view the help file:" 0084 @echo "# mkdir -p $$HOME/.local/share/devhelp/pykst" 0085 @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/pykst" 0086 @echo "# devhelp" 0087 0088 epub: 0089 $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub 0090 @echo 0091 @echo "Build finished. The epub file is in $(BUILDDIR)/epub." 0092 0093 latex: 0094 $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex 0095 @echo 0096 @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex." 0097 @echo "Run \`make' in that directory to run these through (pdf)latex" \ 0098 "(use \`make latexpdf' here to do that automatically)." 0099 0100 latexpdf: 0101 $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex 0102 @echo "Running LaTeX files through pdflatex..." 0103 make -C $(BUILDDIR)/latex all-pdf 0104 @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex." 0105 0106 text: 0107 $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text 0108 @echo 0109 @echo "Build finished. The text files are in $(BUILDDIR)/text." 0110 0111 man: 0112 $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man 0113 @echo 0114 @echo "Build finished. The manual pages are in $(BUILDDIR)/man." 0115 0116 changes: 0117 $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes 0118 @echo 0119 @echo "The overview file is in $(BUILDDIR)/changes." 0120 0121 linkcheck: 0122 $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck 0123 @echo 0124 @echo "Link check complete; look for any errors in the above output " \ 0125 "or in $(BUILDDIR)/linkcheck/output.txt." 0126 0127 doctest: 0128 $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest 0129 @echo "Testing of doctests in the sources finished, look at the " \ 0130 "results in $(BUILDDIR)/doctest/output.txt."