[master] eeee10ffa Retire unused sphinx builders

Dridi Boukelmoune dridi.boukelmoune at gmail.com
Wed Jun 10 15:50:07 UTC 2020

commit eeee10ffa7039adee45d6890576bfd7f14897167
Author: Dridi Boukelmoune <dridi.boukelmoune at gmail.com>
Date:   Wed Jun 10 16:53:28 2020 +0200

    Retire unused sphinx builders
    One exception could be the changes builder, but if we ever reach the
    point where we can automate the changelog initial creation we can bring
    it back.

diff --git a/doc/sphinx/Makefile.am b/doc/sphinx/Makefile.am
index ea010ab1a..a9a47e432 100644
--- a/doc/sphinx/Makefile.am
+++ b/doc/sphinx/Makefile.am
@@ -4,25 +4,16 @@
 # You can set these variables from the command line.
-PAPER         = a4
 BUILDDIR      = build
-ALLSPHINXOPTS   = -d $(BUILDDIR)/doctrees -D latex_elements.papersize=$(PAPER) $(SPHINXOPTS) $(builddir)
+ALLSPHINXOPTS   = -d $(BUILDDIR)/doctrees $(SPHINXOPTS) $(builddir)
-.PHONY: help clean html dirhtml pickle json htmlhelp qthelp latex changes linkcheck doctest
+.PHONY: help clean html linkcheck doctest
 	@echo "Please use \`make <target>' where <target> is one of"
 	@echo "  html      to make standalone HTML files"
-	@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 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)"
 	-rm -rf $(BUILDDIR)/* $(CLEANFILES)
@@ -53,59 +44,12 @@ html: sphinx_prereq
 	@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
-dirhtml: sphinx_prereq
-	$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
-	@echo
-	@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
-pickle: sphinx_prereq
-	@echo
-	@echo "Build finished; now you can process the pickle files."
-json: sphinx_prereq
-	@echo
-	@echo "Build finished; now you can process the JSON files."
-htmlhelp: sphinx_prereq
-	$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
-	@echo
-	@echo "Build finished; now you can run HTML Help Workshop with the" \
-	      ".hhp project file in $(BUILDDIR)/htmlhelp."
-qthelp: sphinx_prereq
-	@echo
-	@echo "Build finished; now you can run "qcollectiongenerator" with the" \
-	      ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
-	@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/Varnish.qhcp"
-	@echo "To view the help file:"
-	@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/Varnish.qhc"
-latex: sphinx_prereq
-	@echo
-	@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: sphinx_prereq
-	$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
-	@echo
-	@echo "The overview file is in $(BUILDDIR)/changes."
 linkcheck: sphinx_prereq
 	$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
 	@echo "Link check complete; look for any errors in the above output " \
 	      "or in $(BUILDDIR)/linkcheck/output.txt."
-doctest: sphinx_prereq
-	$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
-	@echo "Testing of doctests in the sources finished, look at the " \
-	      "results in $(BUILDDIR)/doctest/output.txt."
 	conf.py \
 	dev-guide \

More information about the varnish-commit mailing list