[Python-checkins] r81943 - in python/branches/release26-maint: Doc/README.txt Doc/documenting/building.rst Doc/documenting/index.rst Doc/library/socket.rst

georg.brandl python-checkins at python.org
Sat Jun 12 11:50:02 CEST 2010 

Author: georg.brandl
Date: Sat Jun 12 11:50:02 2010
New Revision: 81943

Log:
Merged revisions 81940-81942 via svnmerge from 
svn+ssh://pythondev@svn.python.org/python/trunk

........
  r81940 | georg.brandl | 2010-06-12 11:45:28 +0200 (Sa, 12 Jun 2010) | 1 line
  
  Add document on how to build.
........
  r81941 | georg.brandl | 2010-06-12 11:45:58 +0200 (Sa, 12 Jun 2010) | 1 line
  
  Fix gratuitous indentation.
........
  r81942 | georg.brandl | 2010-06-12 11:46:03 +0200 (Sa, 12 Jun 2010) | 1 line
  
  Update README.
........


Added:
   python/branches/release26-maint/Doc/documenting/building.rst
      - copied unchanged from r81942, /python/trunk/Doc/documenting/building.rst
Modified:
   python/branches/release26-maint/   (props changed)
   python/branches/release26-maint/Doc/README.txt
   python/branches/release26-maint/Doc/documenting/index.rst
   python/branches/release26-maint/Doc/library/socket.rst

Modified: python/branches/release26-maint/Doc/README.txt
==============================================================================
--- python/branches/release26-maint/Doc/README.txt	(original)
+++ python/branches/release26-maint/Doc/README.txt	Sat Jun 12 11:50:02 2010
@@ -14,12 +14,11 @@
 Building the docs
 =================
 
-You need to install Python 2.4 or higher; the toolset used to build the docs are
-written in Python.  The toolset used to build the documentation is called
-*Sphinx*, it is not included in this tree, but maintained separately in the
-Python Subversion repository.  Also needed are Jinja, a templating engine
-(included in Sphinx as a Subversion external), and optionally Pygments, a code
-highlighter.
+You need to have Python 2.4 or higher installed; the toolset used to build the
+docs is written in Python.  It is called *Sphinx*, it is not included in this
+tree, but maintained separately.  Also needed are the docutils, supplying the
+base markup that Sphinx uses, Jinja, a templating engine, and optionally
+Pygments, a code highlighter.
 
 
 Using make
@@ -42,29 +41,29 @@
    convert them into a single Compiled HTML (.chm) file -- these are popular
    under Microsoft Windows, but very handy on every platform.
 
-   To create the CHM file, you need to run the Microsoft HTML Help Workshop
-   over the generated project (.hhp) file.
+   To create the CHM file, you need to run the Microsoft HTML Help Workshop over
+   the generated project (.hhp) file.
 
- * "latex", which builds LaTeX source files that can be run with "pdflatex"
-   to produce PDF documents.
+ * "latex", which builds LaTeX source files as input to "pdflatex" to produce
+   PDF documents.
 
  * "text", which builds a plain text file for each source file.
 
  * "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.
+   broken, redirected or malformed, and outputs this information to stdout as
+   well as a plain-text (.txt) file.
 
  * "changes", which builds an overview over all versionadded/versionchanged/
    deprecated items in the current version. This is meant as a help for the
    writer of the "What's New" document.
 
- * "coverage", which builds a coverage overview for standard library modules
-   and C API.
+ * "coverage", which builds a coverage overview for standard library modules and
+   C API.
 
- * "pydoc-topics", which builds a Python module containing a dictionary
-   with plain text documentation for the labels defined in
-   `tools/sphinxext/pyspecific.py` -- pydoc needs these to show topic
-   and keyword help.
+ * "pydoc-topics", which builds a Python module containing a dictionary with
+   plain text documentation for the labels defined in
+   `tools/sphinxext/pyspecific.py` -- pydoc needs these to show topic and
+   keyword help.
 
 A "make update" updates the Subversion checkouts in `tools/`.
 
@@ -90,7 +89,7 @@
 
 or by installing it from PyPI.
 
-You can optionally also install Pygments, either as a checkout via :: 
+You can optionally also install Pygments, either as a checkout via ::
 
    svn co http://svn.python.org/projects/external/Pygments-1.3.1/pygments tools/pygments
 

Modified: python/branches/release26-maint/Doc/documenting/index.rst
==============================================================================
--- python/branches/release26-maint/Doc/documenting/index.rst	(original)
+++ python/branches/release26-maint/Doc/documenting/index.rst	Sat Jun 12 11:50:02 2010
@@ -10,9 +10,9 @@
 `reStructuredText`_, developed by the `docutils`_ project, amended by custom
 directives and using a toolset named `Sphinx`_ to postprocess the HTML output.
 
-This document describes the style guide for our documentation, the custom
-reStructuredText markup introduced to support Python documentation and how it
-should be used, as well as the Sphinx build system.
+This document describes the style guide for our documentation as well as the
+custom reStructuredText markup introduced by Sphinx to support Python
+documentation and how it should be used.
 
 .. _reStructuredText: http://docutils.sf.net/rst.html
 .. _docutils: http://docutils.sf.net/
@@ -35,3 +35,4 @@
    rest.rst
    markup.rst
    fromlatex.rst
+   building.rst

Modified: python/branches/release26-maint/Doc/library/socket.rst
==============================================================================
--- python/branches/release26-maint/Doc/library/socket.rst	(original)
+++ python/branches/release26-maint/Doc/library/socket.rst	Sat Jun 12 11:50:02 2010
@@ -72,18 +72,18 @@
    tuple, and the fields depend on the address type. The general tuple form is
    ``(addr_type, v1, v2, v3 [, scope])``, where:
 
-     - *addr_type* is one of TIPC_ADDR_NAMESEQ, TIPC_ADDR_NAME, or
-       TIPC_ADDR_ID.
-     - *scope* is one of TIPC_ZONE_SCOPE, TIPC_CLUSTER_SCOPE, and
-       TIPC_NODE_SCOPE.
-     - If *addr_type* is TIPC_ADDR_NAME, then *v1* is the server type, *v2* is
-       the port identifier, and *v3* should be 0.
+   - *addr_type* is one of TIPC_ADDR_NAMESEQ, TIPC_ADDR_NAME, or
+     TIPC_ADDR_ID.
+   - *scope* is one of TIPC_ZONE_SCOPE, TIPC_CLUSTER_SCOPE, and
+     TIPC_NODE_SCOPE.
+   - If *addr_type* is TIPC_ADDR_NAME, then *v1* is the server type, *v2* is
+     the port identifier, and *v3* should be 0.
 
-       If *addr_type* is TIPC_ADDR_NAMESEQ, then *v1* is the server type, *v2*
-       is the lower port number, and *v3* is the upper port number.
+     If *addr_type* is TIPC_ADDR_NAMESEQ, then *v1* is the server type, *v2*
+     is the lower port number, and *v3* is the upper port number.
 
-       If *addr_type* is TIPC_ADDR_ID, then *v1* is the node, *v2* is the
-       reference, and *v3* should be set to 0.
+     If *addr_type* is TIPC_ADDR_ID, then *v1* is the node, *v2* is the
+     reference, and *v3* should be set to 0.
 
 
 All errors raise exceptions.  The normal exceptions for invalid argument types

More information about the Python-checkins mailing list