mirror of
https://github.com/python/cpython.git
synced 2025-08-03 16:39:00 +00:00
28d88b4813
svn+ssh://pythondev@svn.python.org/python/trunk
................
r68288 | benjamin.peterson | 2009-01-03 18:39:07 -0600 (Sat, 03 Jan 2009) | 1 line
only check the actual compile() call for a SyntaxError
................
r68289 | georg.brandl | 2009-01-04 02:26:10 -0600 (Sun, 04 Jan 2009) | 2 lines
Test commit.
................
r68290 | georg.brandl | 2009-01-04 04:23:49 -0600 (Sun, 04 Jan 2009) | 4 lines
Add "suspicious" builder which finds leftover markup in the HTML files.
Patch by Gabriel Genellina.
................
r68291 | georg.brandl | 2009-01-04 04:24:09 -0600 (Sun, 04 Jan 2009) | 2 lines
Fix two issues found by the suspicious builder.
................
r68325 | benjamin.peterson | 2009-01-04 16:00:18 -0600 (Sun, 04 Jan 2009) | 1 line
use Jinja 2.1.1
................
r68326 | georg.brandl | 2009-01-04 16:03:10 -0600 (Sun, 04 Jan 2009) | 2 lines
Update make.bat.
................
r68338 | neal.norwitz | 2009-01-04 21:57:25 -0600 (Sun, 04 Jan 2009) | 1 line
Make sure to checkout any new packages
................
r68388 | benjamin.peterson | 2009-01-07 21:39:46 -0600 (Wed, 07 Jan 2009) | 1 line
string exceptions are gone
................
r68393 | benjamin.peterson | 2009-01-07 22:01:00 -0600 (Wed, 07 Jan 2009) | 1 line
use new sphinx modules
................
r68423 | benjamin.peterson | 2009-01-08 20:13:34 -0600 (Thu, 08 Jan 2009) | 29 lines
Merged revisions 68306-68308,68340,68368,68422 via svnmerge from
svn+ssh://pythondev@svn.python.org/sandbox/trunk/2to3/lib2to3
........
r68306 | benjamin.peterson | 2009-01-04 12:27:19 -0600 (Sun, 04 Jan 2009) | 1 line
fix_urllib: add mappings for the url parsing functions
........
r68307 | benjamin.peterson | 2009-01-04 12:30:01 -0600 (Sun, 04 Jan 2009) | 1 line
remove duplicated function
........
r68308 | benjamin.peterson | 2009-01-04 12:50:34 -0600 (Sun, 04 Jan 2009) | 1 line
turtle is no longer renamed
........
r68340 | georg.brandl | 2009-01-05 02:11:39 -0600 (Mon, 05 Jan 2009) | 2 lines
Fix undefined locals in parse_tokens().
........
r68368 | benjamin.peterson | 2009-01-06 17:56:10 -0600 (Tue, 06 Jan 2009) | 1 line
fix typo (thanks to Robert Lehmann)
........
r68422 | benjamin.peterson | 2009-01-08 20:01:03 -0600 (Thu, 08 Jan 2009) | 1 line
run the imports fixers after fix_import, so fix_import doesn't try to make stdlib renames into relative imports #4876
........
................
151 lines
5 KiB
Makefile
151 lines
5 KiB
Makefile
#
|
|
# Makefile for Python documentation
|
|
# ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
#
|
|
|
|
# You can set these variables from the command line.
|
|
PYTHON = python2.5
|
|
SVNROOT = http://svn.python.org/projects
|
|
SPHINXOPTS =
|
|
PAPER =
|
|
SOURCES =
|
|
DISTVERSION = $(shell $(PYTHON) tools/sphinxext/patchlevel.py)
|
|
|
|
ALLSPHINXOPTS = -b $(BUILDER) -d build/doctrees -D latex_paper_size=$(PAPER) \
|
|
$(SPHINXOPTS) . build/$(BUILDER) $(SOURCES)
|
|
|
|
.PHONY: help checkout update build html htmlhelp clean coverage dist check
|
|
|
|
help:
|
|
@echo "Please use \`make <target>' where <target> is one of"
|
|
@echo " html to make standalone HTML files"
|
|
@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 " changes to make an overview over all changed/added/deprecated items"
|
|
@echo " linkcheck to check all external links for integrity"
|
|
@echo " suspicious to check for suspicious markup in output text"
|
|
@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 \
|
|
echo "Checking out Sphinx..."; \
|
|
svn checkout $(SVNROOT)/doctools/trunk/sphinx tools/sphinx; \
|
|
fi
|
|
@if [ ! -d tools/docutils ]; then \
|
|
echo "Checking out Docutils..."; \
|
|
svn checkout $(SVNROOT)/external/docutils-0.5/docutils tools/docutils; \
|
|
fi
|
|
@if [ ! -d tools/jinja2 ]; then \
|
|
echo "Checking out Jinja..."; \
|
|
svn checkout $(SVNROOT)/external/Jinja-2.1.1/jinja2 tools/jinja2; \
|
|
fi
|
|
@if [ ! -d tools/pygments ]; then \
|
|
echo "Checking out Pygments..."; \
|
|
svn checkout $(SVNROOT)/external/Pygments-0.11.1/pygments tools/pygments; \
|
|
fi
|
|
|
|
update: checkout
|
|
svn update tools/sphinx
|
|
svn update tools/docutils
|
|
svn update tools/jinja2
|
|
svn update tools/pygments
|
|
|
|
build: checkout
|
|
mkdir -p build/$(BUILDER) build/doctrees
|
|
$(PYTHON) tools/sphinx-build.py $(ALLSPHINXOPTS)
|
|
@echo
|
|
|
|
html: BUILDER = html
|
|
html: build
|
|
@echo "Build finished. The HTML pages are in build/html."
|
|
|
|
htmlhelp: BUILDER = htmlhelp
|
|
htmlhelp: build
|
|
@echo "Build finished; now you can run HTML Help Workshop with the" \
|
|
"build/htmlhelp/pydoc.hhp project file."
|
|
|
|
latex: BUILDER = latex
|
|
latex: build
|
|
@echo "Build finished; the LaTeX files are in build/latex."
|
|
@echo "Run \`make all-pdf' or \`make all-ps' in that directory to" \
|
|
"run these through (pdf)latex."
|
|
|
|
text: BUILDER = text
|
|
text: build
|
|
@echo "Build finished; the text files are in build/text."
|
|
|
|
changes: BUILDER = changes
|
|
changes: build
|
|
@echo "The overview file is in build/changes."
|
|
|
|
linkcheck: BUILDER = linkcheck
|
|
linkcheck: build
|
|
@echo "Link check complete; look for any errors in the above output " \
|
|
"or in build/$(BUILDER)/output.txt"
|
|
|
|
suspicious: BUILDER = suspicious
|
|
suspicious: build
|
|
@echo "Suspicious check complete; look for any errors in the above output " \
|
|
"or in build/$(BUILDER)/suspicious.txt"
|
|
|
|
coverage: BUILDER = coverage
|
|
coverage: build
|
|
@echo "Coverage finished; see c.txt and python.txt in build/coverage"
|
|
|
|
doctest: BUILDER = doctest
|
|
doctest: build
|
|
@echo "Testing of doctests in the sources finished, look at the " \
|
|
"results in build/doctest/output.txt"
|
|
|
|
pydoc-topics: BUILDER = pydoc-topics
|
|
pydoc-topics: build
|
|
@echo "Building finished; now copy build/pydoc-topics/pydoc_topics.py " \
|
|
"into the Lib/ directory"
|
|
|
|
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 -pPR 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 -pPR 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
|
|
|
|
check:
|
|
$(PYTHON) tools/rstlint.py -i tools
|