diff options
| author | Georg Brandl <georg@python.org> | 2011-01-05 11:00:25 (GMT) |
|---|---|---|
| committer | Georg Brandl <georg@python.org> | 2011-01-05 11:00:25 (GMT) |
| commit | 183fe81f8fbb6f924ea12dedac272ce61219e96c (patch) | |
| tree | d80f1bedcb365e8d1188eb8c50b31726e81c2721 /Doc | |
| parent | 069149155bbd0ea33ab263c14c021f93125e9151 (diff) | |
| download | cpython-183fe81f8fbb6f924ea12dedac272ce61219e96c.zip cpython-183fe81f8fbb6f924ea12dedac272ce61219e96c.tar.gz cpython-183fe81f8fbb6f924ea12dedac272ce61219e96c.tar.bz2 | |
#10130: Prepare for building epub-format docs.
Diffstat (limited to 'Doc')
| -rw-r--r-- | Doc/Makefile | 16 | ||||
| -rw-r--r-- | Doc/README.txt | 3 | ||||
| -rw-r--r-- | Doc/tools/sphinxext/download.html | 4 |
3 files changed, 23 insertions, 0 deletions
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.</p> <td><a href="{{ dlbase }}/python-{{ release }}-docs-text.zip">Download</a> (ca. 2 MB)</td> <td><a href="{{ dlbase }}/python-{{ release }}-docs-text.tar.bz2">Download</a> (ca. 1.5 MB)</td> </tr> + <tr><td>EPUB</td> + <td><a href="{{ dlbase }}/python-{{ release }}-docs-epub.zip">Download</a> (ca. 3.5 MB)</td> + <td><a href="{{ dlbase }}/python-{{ release }}-docs-epub.tar.bz2">Download</a> (ca. 3.5 MB)</td> + </tr> </table> |