SPHINXOPTS =
PAPER =
SOURCES =
+DISTVERSION =
ALLSPHINXOPTS = -b $(BUILDER) -d build/doctrees -D latex_paper_size=$(PAPER) \
$(SPHINXOPTS) . build/$(BUILDER) $(SOURCES)
-.PHONY: help checkout update build html htmlhelp clean coverage
+.PHONY: help checkout update build html htmlhelp clean coverage dist
help:
@echo "Please use \`make <target>' where <target> is one of"
@echo " changes to make an overview over all changed/added/deprecated items"
@echo " linkcheck to check all external links for integrity"
@echo " coverage to check documentation coverage for library and C API"
+ @echo " dist to create a \"dist\" directory with archived docs for download"
checkout:
@if [ ! -d tools/sphinx ]; then \
htmlview: html
$(PYTHON) -c "import webbrowser; webbrowser.open('build/html/index.html')"
+
clean:
-rm -rf build/*
-rm -rf tools/sphinx
+
+dist:
+ -rm -rf dist
+ mkdir -p dist
+
+ # archive the HTML
+ make html
+ cp -a build/html dist/python$(DISTVERSION)-docs-html
+ tar -C dist -cf dist/python$(DISTVERSION)-docs-html.tar python$(DISTVERSION)-docs-html
+ bzip2 -9 -k dist/python$(DISTVERSION)-docs-html.tar
+ (cd dist; zip -q -r -9 python$(DISTVERSION)-docs-html.zip python$(DISTVERSION)-docs-html)
+ rm -r dist/python$(DISTVERSION)-docs-html
+ rm dist/python$(DISTVERSION)-docs-html.tar
+
+ # archive the text build
+ make text
+ cp -a build/text dist/python$(DISTVERSION)-docs-text
+ tar -C dist -cf dist/python$(DISTVERSION)-docs-text.tar python$(DISTVERSION)-docs-text
+ bzip2 -9 -k dist/python$(DISTVERSION)-docs-text.tar
+ (cd dist; zip -q -r -9 python$(DISTVERSION)-docs-text.zip python$(DISTVERSION)-docs-text)
+ rm -r dist/python$(DISTVERSION)-docs-text
+ rm dist/python$(DISTVERSION)-docs-text.tar
+
+ # archive the A4 latex
+ -rm -r build/latex
+ make latex PAPER=a4
+ (cd build/latex; make clean && make all-pdf && make FMT=pdf zip bz2)
+ cp build/latex/docs-pdf.zip dist/python$(DISTVERSION)-docs-pdf-a4.zip
+ cp build/latex/docs-pdf.tar.bz2 dist/python$(DISTVERSION)-docs-pdf-a4.tar.bz2
+
+ # archive the letter latex
+ rm -r build/latex
+ make latex PAPER=letter
+ (cd build/latex; make clean && make all-pdf && make FMT=pdf zip bz2)
+ cp build/latex/docs-pdf.zip dist/python$(DISTVERSION)-docs-pdf-letter.zip
+ cp build/latex/docs-pdf.tar.bz2 dist/python$(DISTVERSION)-docs-pdf-letter.tar.bz2
+