diff options
author | Benjamin Peterson <benjamin@python.org> | 2008-12-27 16:00:54 (GMT) |
---|---|---|
committer | Benjamin Peterson <benjamin@python.org> | 2008-12-27 16:00:54 (GMT) |
commit | 9203501bae35a7a6fbec2287324382075177872d (patch) | |
tree | 1ade1461976906524369405232bb36ac704c7148 /Doc | |
parent | db5fe667311745a2bc86355620354449721545f3 (diff) | |
download | cpython-9203501bae35a7a6fbec2287324382075177872d.zip cpython-9203501bae35a7a6fbec2287324382075177872d.tar.gz cpython-9203501bae35a7a6fbec2287324382075177872d.tar.bz2 |
Merged revisions 67889-67892,67895,67898,67904-67907,67912,67918,67920-67921,67923-67924,67926-67927,67930,67943 via svnmerge from
svn+ssh://pythondev@svn.python.org/python/trunk
................
r67889 | benjamin.peterson | 2008-12-20 19:04:32 -0600 (Sat, 20 Dec 2008) | 1 line
sphinx.web is long gone
................
r67890 | benjamin.peterson | 2008-12-20 19:12:26 -0600 (Sat, 20 Dec 2008) | 1 line
update readme
................
r67891 | benjamin.peterson | 2008-12-20 19:14:47 -0600 (Sat, 20 Dec 2008) | 1 line
there are way too many places which need to have the current version added
................
r67892 | benjamin.peterson | 2008-12-20 19:29:32 -0600 (Sat, 20 Dec 2008) | 9 lines
Merged revisions 67809 via svnmerge from
svn+ssh://pythondev@svn.python.org/sandbox/trunk/2to3/lib2to3
........
r67809 | benjamin.peterson | 2008-12-15 21:54:45 -0600 (Mon, 15 Dec 2008) | 1 line
fix logic error
........
................
r67895 | neal.norwitz | 2008-12-21 08:28:32 -0600 (Sun, 21 Dec 2008) | 2 lines
Add Tarek for work on distutils.
................
r67898 | benjamin.peterson | 2008-12-21 15:00:53 -0600 (Sun, 21 Dec 2008) | 1 line
compute DISTVERSION with patchlevel.py
................
r67904 | benjamin.peterson | 2008-12-22 14:44:58 -0600 (Mon, 22 Dec 2008) | 1 line
less attitude
................
r67905 | benjamin.peterson | 2008-12-22 14:51:15 -0600 (Mon, 22 Dec 2008) | 1 line
fix #4720: the format to PyArg_ParseTupleAndKeywords can now start with '|'
................
r67906 | benjamin.peterson | 2008-12-22 14:52:53 -0600 (Mon, 22 Dec 2008) | 1 line
add NEWS note
................
r67907 | benjamin.peterson | 2008-12-22 16:12:19 -0600 (Mon, 22 Dec 2008) | 1 line
silence compiler warning
................
r67912 | georg.brandl | 2008-12-23 06:37:21 -0600 (Tue, 23 Dec 2008) | 2 lines
Fix missing "svn" command.
................
r67918 | georg.brandl | 2008-12-23 09:44:25 -0600 (Tue, 23 Dec 2008) | 2 lines
Markup fix.
................
r67920 | benjamin.peterson | 2008-12-23 14:09:28 -0600 (Tue, 23 Dec 2008) | 1 line
use a global variable, so the compiler doesn't optimize the assignment out
................
r67921 | benjamin.peterson | 2008-12-23 14:12:33 -0600 (Tue, 23 Dec 2008) | 1 line
make global static
................
r67923 | benjamin.peterson | 2008-12-24 09:10:27 -0600 (Wed, 24 Dec 2008) | 1 line
#4736 BufferRWPair.closed shouldn't try to call another property as a function
................
r67924 | benjamin.peterson | 2008-12-24 10:10:05 -0600 (Wed, 24 Dec 2008) | 1 line
pretend exceptions don't exist a while longer
................
r67926 | tarek.ziade | 2008-12-24 13:10:05 -0600 (Wed, 24 Dec 2008) | 1 line
fixed #4400 : distutils .pypirc default generated file was broken.
................
r67927 | benjamin.peterson | 2008-12-26 17:26:30 -0600 (Fri, 26 Dec 2008) | 1 line
python version is included in file name now
................
r67930 | hirokazu.yamamoto | 2008-12-26 22:19:48 -0600 (Fri, 26 Dec 2008) | 2 lines
Issue #4740: Use HIGHEST_PROTOCOL in pickle test.
(There is no behavior difference in 2.x because HIGHEST_PROTOCOL == 2)
................
r67943 | alexandre.vassalotti | 2008-12-27 04:02:59 -0600 (Sat, 27 Dec 2008) | 2 lines
Fix bogus unicode tests in pickletester.
................
Diffstat (limited to 'Doc')
-rw-r--r-- | Doc/Makefile | 34 | ||||
-rw-r--r-- | Doc/README.txt | 16 | ||||
-rw-r--r-- | Doc/c-api/arg.rst | 4 | ||||
-rw-r--r-- | Doc/license.rst | 4 | ||||
-rw-r--r-- | Doc/tools/sphinx-web.py | 14 | ||||
-rw-r--r-- | Doc/tools/sphinxext/download.html | 14 | ||||
-rw-r--r-- | Doc/tutorial/controlflow.rst | 34 | ||||
-rw-r--r-- | Doc/using/unix.rst | 4 |
8 files changed, 45 insertions, 79 deletions
diff --git a/Doc/Makefile b/Doc/Makefile index 81ae419..91da93c 100644 --- a/Doc/Makefile +++ b/Doc/Makefile @@ -9,7 +9,7 @@ SVNROOT = http://svn.python.org/projects SPHINXOPTS = PAPER = SOURCES = -DISTVERSION = +DISTVERSION = $(shell $(PYTHON) tools/sphinxext/patchlevel.py) ALLSPHINXOPTS = -b $(BUILDER) -d build/doctrees -D latex_paper_size=$(PAPER) \ $(SPHINXOPTS) . build/$(BUILDER) $(SOURCES) @@ -111,33 +111,33 @@ 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 + 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 + 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 + 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 + 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 diff --git a/Doc/README.txt b/Doc/README.txt index 03729f6..968986e 100644 --- a/Doc/README.txt +++ b/Doc/README.txt @@ -81,8 +81,7 @@ You'll need to checkout the Sphinx package to the `tools/` directory:: svn co http://svn.python.org/projects/doctools/trunk/sphinx tools/sphinx -Then, you need to install Docutils 0.4 (the SVN snapshot won't work), either -by checking it out via :: +Then, you need to install Docutils, either by checking it out via :: svn co http://svn.python.org/projects/external/docutils-0.4/docutils tools/docutils @@ -99,19 +98,18 @@ Then, make an output directory, e.g. under `build/`, and run :: python tools/sphinx-build.py -b<builder> . build/<outputdirectory> -where `<builder>` is one of html, web or htmlhelp (for explanations see the make -targets above). +where `<builder>` is one of html, text, latex, or htmlhelp (for explanations see +the make targets above). Contributing ============ -For bugs in the content, the online version at http://docs.python.org/ has a -"suggest change" facility that can be used to correct errors in the source text -and submit them as a patch to the maintainers. +Bugs in the content should be reported to the Python bug tracker at +http://bugs.python.org. -Bugs in the toolset should be reported in the Python bug tracker at -http://bugs.python.org/. +Bugs in the toolset should be reported in the Sphinx bug tracker at +http://www.bitbucket.org/birkenfeld/sphinx/issues/. You can also send a mail to the Python Documentation Team at docs@python.org, and we will process your request as soon as possible. diff --git a/Doc/c-api/arg.rst b/Doc/c-api/arg.rst index e90ac39..0c4be63 100644 --- a/Doc/c-api/arg.rst +++ b/Doc/c-api/arg.rst @@ -305,8 +305,8 @@ inside nested parentheses. They are: ``;`` The list of format units ends here; the string after the semicolon is used as - the error message *instead* of the default error message. Clearly, ``:`` and - ``;`` mutually exclude each other. + the error message *instead* of the default error message. ``:`` and ``;`` + mutually exclude each other. Note that any Python object references which are provided to the caller are *borrowed* references; do not decrement their reference count! diff --git a/Doc/license.rst b/Doc/license.rst index dac7100..d15cae8 100644 --- a/Doc/license.rst +++ b/Doc/license.rst @@ -31,6 +31,7 @@ All Python releases are Open Source (see http://www.opensource.org/ for the Open Source Definition). Historically, most, but not all, Python releases have also been GPL-compatible; the table below summarizes the various releases. +<<<<<<< .working +----------------+--------------+------------+------------+-----------------+ | Release | Derived from | Year | Owner | GPL compatible? | +================+==============+============+============+=================+ @@ -90,9 +91,12 @@ been GPL-compatible; the table below summarizes the various releases. +----------------+--------------+------------+------------+-----------------+ | 2.6 | 2.5 | 2008 | PSF | yes | +----------------+--------------+------------+------------+-----------------+ +| 2.6.1 | 2.6 | 2008 | PSF | yes | ++----------------+--------------+------------+------------+-----------------+ | 3.0 | 2.6 | 2008 | PSF | yes | +----------------+--------------+------------+------------+-----------------+ + .. note:: GPL-compatible doesn't mean that we're distributing Python under the GPL. All diff --git a/Doc/tools/sphinx-web.py b/Doc/tools/sphinx-web.py deleted file mode 100644 index 5f7b50b..0000000 --- a/Doc/tools/sphinx-web.py +++ /dev/null @@ -1,14 +0,0 @@ -# -*- coding: utf-8 -*- -""" - Sphinx - Python documentation webserver - ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - - :copyright: 2007 by Georg Brandl. - :license: Python license. -""" - -import sys - -if __name__ == '__main__': - from sphinx.web import main - sys.exit(main(sys.argv)) diff --git a/Doc/tools/sphinxext/download.html b/Doc/tools/sphinxext/download.html index e5a25f7..5f62562 100644 --- a/Doc/tools/sphinxext/download.html +++ b/Doc/tools/sphinxext/download.html @@ -19,20 +19,20 @@ in the table are the size of the download files in megabytes.</p> <table class="docutils"> <tr><th>Format</th><th>Packed as .zip</th><th>Packed as .tar.bz2</th></tr> <tr><td>PDF (US-Letter paper size)</td> - <td><a href="{{ dlbase }}/python-docs-pdf-letter.zip">Download</a> (ca. 8 MB)</td> - <td><a href="{{ dlbase }}/python-docs-pdf-letter.tar.bz2">Download</a> (ca. 8 MB)</td> + <td><a href="{{ dlbase }}/python-{{ release }}-docs-pdf-letter.zip">Download</a> (ca. 8 MB)</td> + <td><a href="{{ dlbase }}/python-{{ release }}-docs-pdf-letter.tar.bz2">Download</a> (ca. 8 MB)</td> </tr> <tr><td>PDF (A4 paper size)</td> - <td><a href="{{ dlbase }}/python-docs-pdf-a4.zip">Download</a> (ca. 8 MB)</td> - <td><a href="{{ dlbase }}/python-docs-pdf-a4.tar.bz2">Download</a> (ca. 8 MB)</td> + <td><a href="{{ dlbase }}/python-{{ release }}-docs-pdf-a4.zip">Download</a> (ca. 8 MB)</td> + <td><a href="{{ dlbase }}/python-{{ release }}-docs-pdf-a4.tar.bz2">Download</a> (ca. 8 MB)</td> </tr> <tr><td>HTML</td> - <td><a href="{{ dlbase }}/python-docs-html.zip">Download</a> (ca. 6 MB)</td> - <td><a href="{{ dlbase }}/python-docs-html.tar.bz2">Download</a> (ca. 4 MB)</td> + <td><a href="{{ dlbase }}/python-{{ release }}-docs-html.zip">Download</a> (ca. 6 MB)</td> + <td><a href="{{ dlbase }}/python-{{ release }}-docs-html.tar.bz2">Download</a> (ca. 4 MB)</td> </tr> <tr><td>Plain Text</td> <td><a href="{{ dlbase }}/python-docs-text.zip">Download</a> (ca. 2 MB)</td> - <td><a href="{{ dlbase }}/python-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> </table> diff --git a/Doc/tutorial/controlflow.rst b/Doc/tutorial/controlflow.rst index 000d9cb..b0b4478 100644 --- a/Doc/tutorial/controlflow.rst +++ b/Doc/tutorial/controlflow.rst @@ -200,42 +200,20 @@ required syntactically but the program requires no action. For example:: ... pass # Busy-wait for keyboard interrupt (Ctrl+C) ... -This is commonly used for creating minimal classes such as exceptions, or -for ignoring unwanted exceptions:: +This is commonly used for creating minimal classes:: - >>> class ParserError(Exception): + >>> class MyEmptyClass: ... pass - ... - >>> try: - ... import audioop - ... except ImportError: - ... pass - ... + ... Another place :keyword:`pass` can be used is as a place-holder for a function or -conditional body when you are working on new code, allowing you to keep -thinking at a more abstract level. However, as :keyword:`pass` is silently -ignored, a better choice may be to raise a :exc:`NotImplementedError` -exception:: +conditional body when you are working on new code, allowing you to keep thinking +at a more abstract level. The :keyword:`pass` is silently ignored:: >>> def initlog(*args): - ... raise NotImplementedError # Open logfile if not already open - ... if not logfp: - ... raise NotImplementedError # Set up dummy log back-end - ... raise NotImplementedError('Call log initialization handler') + ... pass # Remember to implement this! ... -If :keyword:`pass` were used here and you later ran tests, they may fail -without indicating why. Using :exc:`NotImplementedError` causes this code -to raise an exception, telling you exactly where the incomplete code -is. Note the two calling styles of the exceptions above. -The first style, with no message but with an accompanying comment, -lets you easily leave the comment when you remove the exception, -which ideally would be a good description for -the block of code the exception is a placeholder for. However, the -third example, providing a message for the exception, will produce -a more useful traceback. - .. _tut-functions: Defining Functions diff --git a/Doc/using/unix.rst b/Doc/using/unix.rst index 69b76c6..2ab5ee1 100644 --- a/Doc/using/unix.rst +++ b/Doc/using/unix.rst @@ -140,8 +140,8 @@ Editors Vim and Emacs are excellent editors which support Python very well. For more information on how to code in python in these editors, look at: -http://www.vim.org/scripts/script.php?script_id=790 -http://sourceforge.net/projects/python-mode +* http://www.vim.org/scripts/script.php?script_id=790 +* http://sourceforge.net/projects/python-mode Geany is an excellent IDE with support for a lot of languages. For more information, read: http://geany.uvena.de/ |