|
@@ -4,6 +4,8 @@ SPHINXBUILD = sphinx-build
|
|
PAPER =
|
|
PAPER =
|
|
BUILDDIR = ./docs
|
|
BUILDDIR = ./docs
|
|
|
|
|
|
|
|
+BOWER ?= node_modules/.bin/bower
|
|
|
|
+
|
|
# Internal variables.
|
|
# Internal variables.
|
|
PAPEROPT_a4 = -D latex_paper_size=a4
|
|
PAPEROPT_a4 = -D latex_paper_size=a4
|
|
PAPEROPT_letter = -D latex_paper_size=letter
|
|
PAPEROPT_letter = -D latex_paper_size=letter
|
|
@@ -11,7 +13,9 @@ ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) ./d
|
|
# the i18n builder cannot share the environment and doctrees with the others
|
|
# the i18n builder cannot share the environment and doctrees with the others
|
|
I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) ./docs/source
|
|
I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) ./docs/source
|
|
|
|
|
|
-.PHONY: help clean html dirhtml singlehtml json htmlhelp devhelp epub latex latexpdf text changes linkcheck doctest gettext
|
|
|
|
|
|
+.PHONY: all help clean html epub changes linkcheck gettext po pot po2json merge release
|
|
|
|
+
|
|
|
|
+all: dev
|
|
|
|
|
|
help:
|
|
help:
|
|
@echo "Please use \`make <target>' where <target> is one of"
|
|
@echo "Please use \`make <target>' where <target> is one of"
|
|
@@ -30,9 +34,9 @@ help:
|
|
@echo " linkcheck to check all external links for integrity"
|
|
@echo " linkcheck to check all external links for integrity"
|
|
@echo " pot generates a gettext POT file to be used for translations"
|
|
@echo " pot generates a gettext POT file to be used for translations"
|
|
@echo " release to make a new minified release"
|
|
@echo " release to make a new minified release"
|
|
- @echo " singlehtml to make a single large HTML file"
|
|
|
|
- @echo " texinfo to make Texinfo files"
|
|
|
|
- @echo " text to make text files"
|
|
|
|
|
|
+ @echo " linkcheck to check all documentation external links for integrity"
|
|
|
|
+ @echo " epub to export the documentation to epub"
|
|
|
|
+ @echo " changes to make an overview of all changed/added/deprecated items added to the documentation"
|
|
|
|
|
|
pot:
|
|
pot:
|
|
xgettext --keyword=__ --keyword=___ --from-code=UTF-8 --output=locale/converse.pot converse.js --package-name=Converse.js --copyright-holder="Jan-Carel Brand" --package-version=0.7.0 -c --language="python";
|
|
xgettext --keyword=__ --keyword=___ --from-code=UTF-8 --output=locale/converse.pot converse.js --package-name=Converse.js --copyright-holder="Jan-Carel Brand" --package-version=0.7.0 -c --language="python";
|
|
@@ -53,6 +57,10 @@ release:
|
|
sed -i "s/(Unreleased)/(`date +%Y-%m-%d`)/" docs/CHANGES.rst
|
|
sed -i "s/(Unreleased)/(`date +%Y-%m-%d`)/" docs/CHANGES.rst
|
|
grunt minify
|
|
grunt minify
|
|
|
|
|
|
|
|
+dev:
|
|
|
|
+ npm install
|
|
|
|
+ ${BOWER} update;
|
|
|
|
+
|
|
clean:
|
|
clean:
|
|
-rm -rf $(BUILDDIR)/*
|
|
-rm -rf $(BUILDDIR)/*
|
|
|
|
|
|
@@ -61,72 +69,11 @@ html:
|
|
@echo
|
|
@echo
|
|
@echo "Build finished. The HTML pages are in $(BUILDDIR)/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."
|
|
|
|
-
|
|
|
|
-singlehtml:
|
|
|
|
- $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
|
|
|
|
- @echo
|
|
|
|
- @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
|
|
|
|
-
|
|
|
|
-json:
|
|
|
|
- $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
|
|
|
|
- @echo
|
|
|
|
- @echo "Build finished; now you can process the JSON files."
|
|
|
|
-
|
|
|
|
-htmlhelp:
|
|
|
|
- $(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."
|
|
|
|
-
|
|
|
|
-devhelp:
|
|
|
|
- $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
|
|
|
|
- @echo
|
|
|
|
- @echo "Build finished."
|
|
|
|
- @echo "To view the help file:"
|
|
|
|
- @echo "# mkdir -p $$HOME/.local/share/devhelp/sphinx"
|
|
|
|
- @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/sphinx"
|
|
|
|
- @echo "# devhelp"
|
|
|
|
-
|
|
|
|
epub:
|
|
epub:
|
|
$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
|
|
$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
|
|
@echo
|
|
@echo
|
|
@echo "Build finished. The epub file is in $(BUILDDIR)/epub."
|
|
@echo "Build finished. The epub file is in $(BUILDDIR)/epub."
|
|
|
|
|
|
-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."
|
|
|
|
-
|
|
|
|
-texinfo:
|
|
|
|
- $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
|
|
|
|
- @echo
|
|
|
|
- @echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
|
|
|
|
- @echo "Run \`make' in that directory to run these through makeinfo" \
|
|
|
|
- "(use \`make info' here to do that automatically)."
|
|
|
|
-
|
|
|
|
-info:
|
|
|
|
- $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
|
|
|
|
- @echo "Running Texinfo files through makeinfo..."
|
|
|
|
- make -C $(BUILDDIR)/texinfo info
|
|
|
|
- @echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
|
|
|
|
-
|
|
|
|
gettext:
|
|
gettext:
|
|
$(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
|
|
$(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
|
|
@echo
|
|
@echo
|
|
@@ -142,8 +89,3 @@ linkcheck:
|
|
@echo
|
|
@echo
|
|
@echo "Link check complete; look for any errors in the above output " \
|
|
@echo "Link check complete; look for any errors in the above output " \
|
|
"or in $(BUILDDIR)/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."
|
|
|