From 183fe81f8fbb6f924ea12dedac272ce61219e96c Mon Sep 17 00:00:00 2001 From: Georg Brandl Date: Wed, 5 Jan 2011 11:00:25 +0000 Subject: #10130: Prepare for building epub-format docs. --- Doc/Makefile | 16 ++++++++++++++++ Doc/README.txt | 3 +++ Doc/tools/sphinxext/download.html | 4 ++++ 3 files changed, 23 insertions(+) diff --git a/Doc/Makefile b/Doc/Makefile index 83b2170..e7708fd 100644 --- a/Doc/Makefile +++ b/Doc/Makefile @@ -26,6 +26,7 @@ help: @echo " htmlhelp to make HTML files and a HTML help project" @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter" @echo " text to make plain text files" + @echo " epub to make EPUB files" @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" @@ -81,6 +82,10 @@ text: BUILDER = text text: build @echo "Build finished; the text files are in build/text." +epub: BUILDER = epub +epub: build + @echo "Build finished; the epub files are in build/epub." + changes: BUILDER = changes changes: build @echo "The overview file is in build/changes." @@ -158,6 +163,17 @@ dist: 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 + # archive the epub build + rm -rf build/epub + make epub + mkdir -p dist/python-$(DISTVERSION)-docs-epub + cp -pPR build/epub/*.epub dist/python-$(DISTVERSION)-docs-epub/ + tar -C dist -cf dist/python-$(DISTVERSION)-docs-epub.tar python-$(DISTVERSION)-docs-epub + bzip2 -9 -k dist/python-$(DISTVERSION)-docs-epub.tar + (cd dist; zip -q -r -9 python-$(DISTVERSION)-docs-epub.zip python-$(DISTVERSION)-docs-epub) + rm -r dist/python-$(DISTVERSION)-docs-epub + rm dist/python-$(DISTVERSION)-docs-epub.tar + check: $(PYTHON) tools/rstlint.py -i tools diff --git a/Doc/README.txt b/Doc/README.txt index 03b1c7f..e386e87 100644 --- a/Doc/README.txt +++ b/Doc/README.txt @@ -54,6 +54,9 @@ Available make targets are: * "text", which builds a plain text file for each source file. + * "epub", which builds an EPUB document, suitable to be viewed on e-book + readers. + * "linkcheck", which checks all external references to see whether they are broken, redirected or malformed, and outputs this information to stdout as well as a plain-text (.txt) file. diff --git a/Doc/tools/sphinxext/download.html b/Doc/tools/sphinxext/download.html index 4fca138..f89c458 100644 --- a/Doc/tools/sphinxext/download.html +++ b/Doc/tools/sphinxext/download.html @@ -33,6 +33,10 @@ in the table are the size of the download files in megabytes.

Download (ca. 2 MB) Download (ca. 1.5 MB) + EPUB + Download (ca. 3.5 MB) + Download (ca. 3.5 MB) + -- cgit v0.12