1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/testing/mozbase/docs/Makefile Wed Dec 31 06:09:35 2014 +0100
1.3 @@ -0,0 +1,153 @@
1.4 +# Makefile for Sphinx documentation
1.5 +#
1.6 +
1.7 +# You can set these variables from the command line.
1.8 +SPHINXOPTS =
1.9 +SPHINXBUILD = sphinx-build
1.10 +PAPER =
1.11 +BUILDDIR = _build
1.12 +
1.13 +# Internal variables.
1.14 +PAPEROPT_a4 = -D latex_paper_size=a4
1.15 +PAPEROPT_letter = -D latex_paper_size=letter
1.16 +ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
1.17 +# the i18n builder cannot share the environment and doctrees with the others
1.18 +I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
1.19 +
1.20 +.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext
1.21 +
1.22 +help:
1.23 + @echo "Please use \`make <target>' where <target> is one of"
1.24 + @echo " html to make standalone HTML files"
1.25 + @echo " dirhtml to make HTML files named index.html in directories"
1.26 + @echo " singlehtml to make a single large HTML file"
1.27 + @echo " pickle to make pickle files"
1.28 + @echo " json to make JSON files"
1.29 + @echo " htmlhelp to make HTML files and a HTML help project"
1.30 + @echo " qthelp to make HTML files and a qthelp project"
1.31 + @echo " devhelp to make HTML files and a Devhelp project"
1.32 + @echo " epub to make an epub"
1.33 + @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
1.34 + @echo " latexpdf to make LaTeX files and run them through pdflatex"
1.35 + @echo " text to make text files"
1.36 + @echo " man to make manual pages"
1.37 + @echo " texinfo to make Texinfo files"
1.38 + @echo " info to make Texinfo files and run them through makeinfo"
1.39 + @echo " gettext to make PO message catalogs"
1.40 + @echo " changes to make an overview of all changed/added/deprecated items"
1.41 + @echo " linkcheck to check all external links for integrity"
1.42 + @echo " doctest to run all doctests embedded in the documentation (if enabled)"
1.43 +
1.44 +clean:
1.45 + -rm -rf $(BUILDDIR)/*
1.46 +
1.47 +html:
1.48 + $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
1.49 + @echo
1.50 + @echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
1.51 +
1.52 +dirhtml:
1.53 + $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
1.54 + @echo
1.55 + @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
1.56 +
1.57 +singlehtml:
1.58 + $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
1.59 + @echo
1.60 + @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
1.61 +
1.62 +pickle:
1.63 + $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
1.64 + @echo
1.65 + @echo "Build finished; now you can process the pickle files."
1.66 +
1.67 +json:
1.68 + $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
1.69 + @echo
1.70 + @echo "Build finished; now you can process the JSON files."
1.71 +
1.72 +htmlhelp:
1.73 + $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
1.74 + @echo
1.75 + @echo "Build finished; now you can run HTML Help Workshop with the" \
1.76 + ".hhp project file in $(BUILDDIR)/htmlhelp."
1.77 +
1.78 +qthelp:
1.79 + $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
1.80 + @echo
1.81 + @echo "Build finished; now you can run "qcollectiongenerator" with the" \
1.82 + ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
1.83 + @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/MozBase.qhcp"
1.84 + @echo "To view the help file:"
1.85 + @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/MozBase.qhc"
1.86 +
1.87 +devhelp:
1.88 + $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
1.89 + @echo
1.90 + @echo "Build finished."
1.91 + @echo "To view the help file:"
1.92 + @echo "# mkdir -p $$HOME/.local/share/devhelp/MozBase"
1.93 + @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/MozBase"
1.94 + @echo "# devhelp"
1.95 +
1.96 +epub:
1.97 + $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
1.98 + @echo
1.99 + @echo "Build finished. The epub file is in $(BUILDDIR)/epub."
1.100 +
1.101 +latex:
1.102 + $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
1.103 + @echo
1.104 + @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
1.105 + @echo "Run \`make' in that directory to run these through (pdf)latex" \
1.106 + "(use \`make latexpdf' here to do that automatically)."
1.107 +
1.108 +latexpdf:
1.109 + $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
1.110 + @echo "Running LaTeX files through pdflatex..."
1.111 + $(MAKE) -C $(BUILDDIR)/latex all-pdf
1.112 + @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
1.113 +
1.114 +text:
1.115 + $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
1.116 + @echo
1.117 + @echo "Build finished. The text files are in $(BUILDDIR)/text."
1.118 +
1.119 +man:
1.120 + $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
1.121 + @echo
1.122 + @echo "Build finished. The manual pages are in $(BUILDDIR)/man."
1.123 +
1.124 +texinfo:
1.125 + $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
1.126 + @echo
1.127 + @echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
1.128 + @echo "Run \`make' in that directory to run these through makeinfo" \
1.129 + "(use \`make info' here to do that automatically)."
1.130 +
1.131 +info:
1.132 + $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
1.133 + @echo "Running Texinfo files through makeinfo..."
1.134 + make -C $(BUILDDIR)/texinfo info
1.135 + @echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
1.136 +
1.137 +gettext:
1.138 + $(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
1.139 + @echo
1.140 + @echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
1.141 +
1.142 +changes:
1.143 + $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
1.144 + @echo
1.145 + @echo "The overview file is in $(BUILDDIR)/changes."
1.146 +
1.147 +linkcheck:
1.148 + $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
1.149 + @echo
1.150 + @echo "Link check complete; look for any errors in the above output " \
1.151 + "or in $(BUILDDIR)/linkcheck/output.txt."
1.152 +
1.153 +doctest:
1.154 + $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
1.155 + @echo "Testing of doctests in the sources finished, look at the " \
1.156 + "results in $(BUILDDIR)/doctest/output.txt."
