Mirror
/
cpython
mirror of https://github.com/python/cpython
4
1
Fork 0
Code Issues Releases Wiki Activity

#10130: Prepare for building epub-format docs.

This commit is contained in:
Georg Brandl 2011-01-05 11:00:25 +00:00
parent 069149155b
commit 183fe81f8f
3 changed files with 23 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
Doc/Makefile
View File

@ -26,6 +26,7 @@ help:
@echo " htmlhelp to make HTML files and a HTML help project" @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 " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
@echo " text to make plain text files" @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 " changes to make an overview over all changed/added/deprecated items"
@echo " linkcheck to check all external links for integrity" @echo " linkcheck to check all external links for integrity"
@echo " coverage to check documentation coverage for library and C API" @echo " coverage to check documentation coverage for library and C API"
@ -81,6 +82,10 @@ text: BUILDER = text
text: build text: build
@echo "Build finished; the text files are in build/text." @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: BUILDER = changes
changes: build changes: build
@echo "The overview file is in build/changes." @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.zip dist/python-$(DISTVERSION)-docs-pdf-letter.zip
cp build/latex/docs-pdf.tar.bz2 dist/python-$(DISTVERSION)-docs-pdf-letter.tar.bz2 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: check:
$(PYTHON) tools/rstlint.py -i tools $(PYTHON) tools/rstlint.py -i tools

3
Doc/README.txt
View File

@ -54,6 +54,9 @@ Available make targets are:
* "text", which builds a plain text file for each source file. * "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 * "linkcheck", which checks all external references to see whether they are
broken, redirected or malformed, and outputs this information to stdout as broken, redirected or malformed, and outputs this information to stdout as
well as a plain-text (.txt) file. well as a plain-text (.txt) file.

4
Doc/tools/sphinxext/download.html
View File

@ -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.zip">Download</a> (ca. 2 MB)</td>
<td><a href="{{ dlbase }}/python-{{ release }}-docs-text.tar.bz2">Download</a> (ca. 1.5 MB)</td> <td><a href="{{ dlbase }}/python-{{ release }}-docs-text.tar.bz2">Download</a> (ca. 1.5 MB)</td>
</tr> </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> </table>