2 # included from Top Level Makefile.am
3 # All paths should be given relative to the root
5 # Makefile for Sphinx documentation
8 SPHINXOPTS = ${SPHINX_WARNINGS}
10 SPHINX_BUILDDIR = ${top_builddir}/docs
13 PAPEROPT_a4 = -D latex_paper_size=a4
14 PAPEROPT_letter = -D latex_paper_size=letter
15 ALLSPHINXOPTS = -d $(SPHINX_BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) ${top_srcdir}/docs
17 .PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest
22 @echo "Please use \`make <target>' where <target> is one of"
23 @echo " html to make standalone HTML files"
24 @echo " dirhtml to make HTML files named index.html in directories"
25 @echo " singlehtml to make a single large HTML file"
26 @echo " pickle to make pickle files"
27 @echo " json to make JSON files"
28 @echo " htmlhelp to make HTML files and a HTML help project"
29 @echo " qthelp to make HTML files and a qthelp project"
30 @echo " devhelp to make HTML files and a Devhelp project"
31 @echo " epub to make an epub"
32 @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
33 @echo " latexpdf to make LaTeX files and run them through pdflatex"
34 @echo " text to make text files"
35 @echo " man to make manual pages"
36 @echo " changes to make an overview of all changed/added/deprecated items"
37 @echo " linkcheck to check all external links for integrity"
38 @echo " doctest to run all doctests embedded in the documentation (if enabled)"
41 @$(mkdir_p) docs/_static
43 html-local: docs/conf.py docs changes docs/_static
44 PYTHONPATH=${top_srcdir}/docs $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/html
46 @echo "Build finished. The HTML pages are in $(SPHINX_BUILDDIR)/html."
49 PYTHONPATH=${top_srcdir}/docs $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/dirhtml
51 @echo "Build finished. The HTML pages are in $(SPHINX_BUILDDIR)/dirhtml."
53 singlehtml: html-local
54 PYTHONPATH=${top_srcdir}/docs $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/singlehtml
56 @echo "Build finished. The HTML page is in $(SPHINX_BUILDDIR)/singlehtml."
59 PYTHONPATH=${top_srcdir}/docs $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/pickle
61 @echo "Build finished; now you can process the pickle files."
64 PYTHONPATH=${top_srcdir}/docs $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/json
66 @echo "Build finished; now you can process the JSON files."
68 htmlhelp: docs/conf.py
69 PYTHONPATH=${top_srcdir}/docs $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/htmlhelp
71 @echo "Build finished; now you can run HTML Help Workshop with the" \
72 ".hhp project file in $(SPHINX_BUILDDIR)/htmlhelp."
75 PYTHONPATH=${top_srcdir}/docs $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/qthelp
77 @echo "Build finished; now you can run "qcollectiongenerator" with the" \
78 ".qhcp project file in $(SPHINX_BUILDDIR)/qthelp, like this:"
79 @echo "# qcollectiongenerator $(SPHINX_BUILDDIR)/qthelp/Libmemcached.qhcp"
80 @echo "To view the help file:"
81 @echo "# assistant -collectionFile $(SPHINX_BUILDDIR)/qthelp/Libmemcached.qhc"
84 PYTHONPATH=${top_srcdir}/docs $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/devhelp
86 @echo "Build finished."
87 @echo "To view the help file:"
88 @echo "# mkdir -p $$HOME/.local/share/devhelp/Libmemcached"
89 @echo "# ln -s $(SPHINX_BUILDDIR)/devhelp $$HOME/.local/share/devhelp/Libmemcached"
93 PYTHONPATH=${top_srcdir}/docs $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/epub
95 @echo "Build finished. The epub file is in $(SPHINX_BUILDDIR)/epub."
98 PYTHONPATH=${top_srcdir}/docs $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/latex
100 @echo "Build finished; the LaTeX files are in $(SPHINX_BUILDDIR)/latex."
101 @echo "Run \`make' in that directory to run these through (pdf)latex" \
102 "(use \`make latexpdf' here to do that automatically)."
105 PYTHONPATH=${top_srcdir}/docs $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/latex
106 @echo "Running LaTeX files through pdflatex..."
107 make -C $(SPHINX_BUILDDIR)/latex all-pdf
108 @echo "pdflatex finished; the PDF files are in $(SPHINX_BUILDDIR)/latex."
111 PYTHONPATH=${top_srcdir}/docs $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/text
113 @echo "Build finished. The text files are in $(SPHINX_BUILDDIR)/text."
115 if HAVE_RECENT_SPHINX
117 PYTHONPATH=${top_srcdir}/docs $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) ${top_srcdir}/man
119 @echo "Build finished. The manual pages are in ${top_srcdir}/man."
127 changes: docs/conf.py
128 PYTHONPATH=${top_srcdir}/docs $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/changes
130 @echo "The overview file is in $(SPHINX_BUILDDIR)/changes."
132 linkcheck: docs/conf.py
133 PYTHONPATH=${top_srcdir}/docs $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/linkcheck
135 @echo "Link check complete; look for any errors in the above output " \
136 "or in $(SPHINX_BUILDDIR)/linkcheck/output.txt."
138 doctest: docs/conf.py
139 PYTHONPATH=${top_srcdir}/docs $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/doctest
140 @echo "Testing of doctests in the sources finished, look at the " \
141 "results in $(SPHINX_BUILDDIR)/doctest/output.txt."