X-Git-Url: https://git.m6w6.name/?a=blobdiff_plain;f=docs%2Finclude.am;h=f28079f8d6745b36a2912d482b977a703a47ef27;hb=dd1ce96a2171e9a2e13c08e56e22b03008e87367;hp=d4b8140d9d9f253152ccc4647571516157b4f527;hpb=1f3d43109ef752862093f8e4340fcfec1832b3be;p=awesomized%2Flibmemcached diff --git a/docs/include.am b/docs/include.am index d4b8140d..f28079f8 100644 --- a/docs/include.am +++ b/docs/include.am @@ -5,14 +5,14 @@ # Makefile for Sphinx documentation # -SPHINXOPTS = ${SPHINX_WARNINGS} +SPHINXOPTS = ${SPHINX_WARNINGS} -q PAPER = -SPHINX_BUILDDIR = ${top_builddir}/docs +SPHINX_BUILDDIR = ${abs_top_builddir}/docs # Internal variables. PAPEROPT_a4 = -D latex_paper_size=a4 PAPEROPT_letter = -D latex_paper_size=letter -ALLSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) $(SPHINX_BUILDDIR) +ALLSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) $(SPHINX_BUILDDIR) .PHONY: clean-docs-check clean-docs-check: @@ -20,12 +20,9 @@ clean-docs-check: .PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest -if HAVE_SPHINX - sphinx-help: @echo "Please use \`make ' where 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 " pickle to make pickle files" @echo " json to make JSON files" @@ -41,23 +38,15 @@ sphinx-help: @echo " linkcheck to check all external links for integrity" @echo " doctest to run all doctests embedded in the documentation (if enabled)" -docs/_static: - @$(mkdir_p) docs/_static +install-html-local: html-local + @$(MKDIR_P) $(htmldir)/html + @cp -r ${top_builddir}/html $(htmldir)/ -html-local: docs/conf.py docs changes docs/_static - PYTHONPATH=${top_srcdir}/docs $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/html - @echo - @echo "Build finished. The HTML pages are in $(SPHINX_BUILDDIR)/html." - -dirhtml: html-local - PYTHONPATH=${top_srcdir}/docs $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/dirhtml - @echo - @echo "Build finished. The HTML pages are in $(SPHINX_BUILDDIR)/dirhtml." +html-local: docs/conf.py + @PYTHONPATH=${top_srcdir}/docs $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) ${top_builddir}/html singlehtml: html-local - PYTHONPATH=${top_srcdir}/docs $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/singlehtml - @echo - @echo "Build finished. The HTML page is in $(SPHINX_BUILDDIR)/singlehtml." + @PYTHONPATH=${top_srcdir}/docs $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/singlehtml pickle: docs/conf.py PYTHONPATH=${top_srcdir}/docs $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/pickle @@ -75,24 +64,6 @@ htmlhelp: docs/conf.py @echo "Build finished; now you can run HTML Help Workshop with the" \ ".hhp project file in $(SPHINX_BUILDDIR)/htmlhelp." -qthelp: docs/conf.py - PYTHONPATH=${top_srcdir}/docs $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/qthelp - @echo - @echo "Build finished; now you can run "qcollectiongenerator" with the" \ - ".qhcp project file in $(SPHINX_BUILDDIR)/qthelp, like this:" - @echo "# qcollectiongenerator $(SPHINX_BUILDDIR)/qthelp/Libmemcached.qhcp" - @echo "To view the help file:" - @echo "# assistant -collectionFile $(SPHINX_BUILDDIR)/qthelp/Libmemcached.qhc" - -devhelp: docs/conf.py - PYTHONPATH=${top_srcdir}/docs $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/devhelp - @echo - @echo "Build finished." - @echo "To view the help file:" - @echo "# mkdir -p $$HOME/.local/share/devhelp/Libmemcached" - @echo "# ln -s $(SPHINX_BUILDDIR)/devhelp $$HOME/.local/share/devhelp/Libmemcached" - @echo "# devhelp" - epub: docs/conf.py PYTHONPATH=${top_srcdir}/docs $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/epub @echo @@ -112,38 +83,19 @@ latexpdf: latex @echo "pdflatex finished; the PDF files are in $(SPHINX_BUILDDIR)/latex." text: docs/conf.py - PYTHONPATH=${top_srcdir}/docs $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/text - @echo - @echo "Build finished. The text files are in $(SPHINX_BUILDDIR)/text." + @PYTHONPATH=${top_srcdir}/docs $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/text -if HAVE_RECENT_SPHINX man: - PYTHONPATH=$(SPHINX_BUILDDIR)/docs $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) ${top_builddir}/man + @PYTHONPATH=$(SPHINX_BUILDDIR)/docs $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) ${top_builddir}/man -else - -man: - -endif changes: docs/conf.py - PYTHONPATH=${top_srcdir}/docs $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/changes - @echo - @echo "The overview file is in $(SPHINX_BUILDDIR)/changes." + @PYTHONPATH=${top_srcdir}/docs $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/changes linkcheck: docs/conf.py PYTHONPATH=${top_srcdir}/docs $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/linkcheck - @echo - @echo "Link check complete; look for any errors in the above output " \ - "or in $(SPHINX_BUILDDIR)/linkcheck/output.txt." doctest: docs/conf.py PYTHONPATH=${top_srcdir}/docs $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/doctest @echo "Testing of doctests in the sources finished, look at the " \ "results in $(SPHINX_BUILDDIR)/doctest/output.txt." - -else - -man: - -endif