Ticket #13484: django-sphinx.diff

docs/Makefile

@@ -5 +5 @@
 SPHINXOPTS    =
 SPHINXBUILD   = sphinx-build
 PAPER         =
+BUILDDIR      = _build
 
 # Internal variables.
 PAPEROPT_a4     = -D latex_paper_size=a4
 PAPEROPT_letter = -D latex_paper_size=letter
-ALLSPHINXOPTS   = -d _build/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
+ALLSPHINXOPTS   = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
 
-.PHONY: help clean html web pickle htmlhelp latex changes linkcheck
+.PHONY: help clean html dirhtml pickle json htmlhelp qthelp latex changes linkcheck doctest
 
 help:
         @echo "Please use \`make <target>' where <target> is one of"
         @echo "  html      to make standalone HTML files"
-        @echo "  pickle    to make pickle files (usable by e.g. sphinx-web)"
+        @echo "  dirhtml   to make HTML files named index.html in directories"
+        @echo "  pickle    to make pickle files"
+        @echo "  json      to make JSON files"
         @echo "  htmlhelp  to make HTML files and a HTML help project"
+        @echo "  qthelp    to make HTML files and a qthelp project"
         @echo "  latex     to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
-        @echo "  changes   to make an overview over all changed/added/deprecated items"
+        @echo "  changes   to make an overview of all changed/added/deprecated items"
         @echo "  linkcheck to check all external links for integrity"
+        @echo "  doctest   to run all doctests embedded in the documentation (if enabled)"
 
 clean:
-        -rm -rf _build/*
+        -rm -rf $(BUILDDIR)/*
 
 html:
-        mkdir -p _build/html _build/doctrees
-        $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) _build/html
+        $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
         @echo
-        @echo "Build finished. The HTML pages are in _build/html."
+        @echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
+
+dirhtml:
+        $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
+        @echo
+        @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
 
 pickle:
-        mkdir -p _build/pickle _build/doctrees
-        $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) _build/pickle
+        $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
         @echo
-        @echo "Build finished; now you can process the pickle files or run"
-        @echo "  sphinx-web _build/pickle"
-        @echo "to start the sphinx-web server."
+        @echo "Build finished; now you can process the pickle files."
 
-web: pickle
+json:
+        $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
+        @echo
+        @echo "Build finished; now you can process the JSON files."
 
 htmlhelp:
-        mkdir -p _build/htmlhelp _build/doctrees
-        $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) _build/htmlhelp
+        $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
         @echo
         @echo "Build finished; now you can run HTML Help Workshop with the" \
-              ".hhp project file in _build/htmlhelp."
+              ".hhp project file in $(BUILDDIR)/htmlhelp."
+
+qthelp:
+        $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
+        @echo
+        @echo "Build finished; now you can run "qcollectiongenerator" with the" \
+              ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
+        @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/django.qhcp"
+        @echo "To view the help file:"
+        @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/django.qhc"
 
 latex:
-        mkdir -p _build/latex _build/doctrees
-        $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) _build/latex
+        $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
         @echo
-        @echo "Build finished; the LaTeX files are in _build/latex."
+        @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
         @echo "Run \`make all-pdf' or \`make all-ps' in that directory to" \
               "run these through (pdf)latex."
 
 changes:
-        mkdir -p _build/changes _build/doctrees
-        $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) _build/changes
+        $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
         @echo
-        @echo "The overview file is in _build/changes."
+        @echo "The overview file is in $(BUILDDIR)/changes."
 
 linkcheck:
-        mkdir -p _build/linkcheck _build/doctrees
-        $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) _build/linkcheck
+        $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
         @echo
         @echo "Link check complete; look for any errors in the above output " \
-              "or in _build/linkcheck/output.txt."
+              "or in $(BUILDDIR)/linkcheck/output.txt."
+
+doctest:
+        $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
+        @echo "Testing of doctests in the sources finished, look at the " \
+              "results in $(BUILDDIR)/doctest/output.txt."