add manifest link

[wolnelektury.git] / doc / Makefile

diff --git a/doc/Makefile b/doc/Makefile
index dfe1c40..6d2a511 100644 (file)
--- a/doc/Makefile
+++ b/doc/Makefile
@@ -5,84 +5,126 @@
 SPHINXOPTS    =
 SPHINXBUILD   = sphinx-build
 PAPER         =
 SPHINXOPTS    =
 SPHINXBUILD   = sphinx-build
 PAPER         =

+BUILDDIR      = _build

 
 # Internal variables.
 PAPEROPT_a4     = -D latex_paper_size=a4
 PAPEROPT_letter = -D latex_paper_size=letter
 
 # 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 dirhtml pickle json htmlhelp qthelp latex changes linkcheck doctest
+.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest

 
 help:
        @echo "Please use \`make <target>' where <target> is one of"
 
 help:
        @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)"
+       @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"
+       @echo "  htmlhelp   to make HTML files and a HTML help project"
+       @echo "  qthelp     to make HTML files and a qthelp project"
+       @echo "  devhelp    to make HTML files and a Devhelp project"
+       @echo "  epub       to make an epub"
+       @echo "  latex      to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
+       @echo "  latexpdf   to make LaTeX files and run them through pdflatex"
+       @echo "  text       to make text files"
+       @echo "  man        to make manual pages"
+       @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:
 
 clean:

-       -rm -rf _build/*
+       -rm -rf $(BUILDDIR)/*

 
 html:
 
 html:

-       $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) _build/html
+       $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html

        @echo
        @echo

-       @echo "Build finished. The HTML pages are in _build/html."
+       @echo "Build finished. The HTML pages are in $(BUILDDIR)/html."

 
 dirhtml:
 
 dirhtml:

-       $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) _build/dirhtml
+       $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml

        @echo
        @echo

-       @echo "Build finished. The HTML pages are in _build/dirhtml."
+       @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
+
+singlehtml:
+       $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
+       @echo
+       @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."

 
 pickle:
 
 pickle:

-       $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) _build/pickle
+       $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle

        @echo
        @echo "Build finished; now you can process the pickle files."
 
 json:
        @echo
        @echo "Build finished; now you can process the pickle files."
 
 json:

-       $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) _build/json
+       $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json

        @echo
        @echo "Build finished; now you can process the JSON files."
 
 htmlhelp:
        @echo
        @echo "Build finished; now you can process the JSON files."
 
 htmlhelp:

-       $(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" \
        @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:
 
 qthelp:

-       $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) _build/qthelp
+       $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp

        @echo
        @echo "Build finished; now you can run "qcollectiongenerator" with the" \
        @echo
        @echo "Build finished; now you can run "qcollectiongenerator" with the" \

-             ".qhcp project file in _build/qthelp, like this:"
-       @echo "# qcollectiongenerator _build/qthelp/WolneLektury.pl.qhcp"
+             ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
+       @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/WolneLektury.qhcp"
+       @echo "To view the help file:"
+       @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/WolneLektury.qhc"
+
+devhelp:
+       $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
+       @echo
+       @echo "Build finished."

        @echo "To view the help file:"
        @echo "To view the help file:"

-       @echo "# assistant -collectionFile _build/qthelp/WolneLektury.pl.qhc"
+       @echo "# mkdir -p $$HOME/.local/share/devhelp/WolneLektury"
+       @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/WolneLektury"
+       @echo "# devhelp"
+
+epub:
+       $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
+       @echo
+       @echo "Build finished. The epub file is in $(BUILDDIR)/epub."

 
 latex:
 
 latex:

-       $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) _build/latex
+       $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+       @echo
+       @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
+       @echo "Run \`make' in that directory to run these through (pdf)latex" \
+             "(use \`make latexpdf' here to do that automatically)."
+
+latexpdf:
+       $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+       @echo "Running LaTeX files through pdflatex..."
+       make -C $(BUILDDIR)/latex all-pdf
+       @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
+
+text:
+       $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
+       @echo
+       @echo "Build finished. The text files are in $(BUILDDIR)/text."
+
+man:
+       $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man

        @echo
        @echo

-       @echo "Build finished; the LaTeX files are in _build/latex."
-       @echo "Run \`make all-pdf' or \`make all-ps' in that directory to" \
-             "run these through (pdf)latex."
+       @echo "Build finished. The manual pages are in $(BUILDDIR)/man."

 
 changes:
 
 changes:

-       $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) _build/changes
+       $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes

        @echo
        @echo

-       @echo "The overview file is in _build/changes."
+       @echo "The overview file is in $(BUILDDIR)/changes."

 
 linkcheck:
 
 linkcheck:

-       $(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 " \
        @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:
 
 doctest:

-       $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) _build/doctest
+       $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest

        @echo "Testing of doctests in the sources finished, look at the " \
        @echo "Testing of doctests in the sources finished, look at the " \

-             "results in _build/doctest/output.txt."
+             "results in $(BUILDDIR)/doctest/output.txt."