From: Georg Brandl <georg@python.org>
Date: Mon, 10 Mar 2014 18:31:52 +0000 (+0100)
Subject: Closes #20090: update Doc/README.txt for the changes in the 3.4 branch.
X-Git-Tag: v3.4.1rc1~233^2~80
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=02e77d17fae3e9dea5f040375a8ed9ec21259a4b;p=thirdparty%2FPython%2Fcpython.git

Closes #20090: update Doc/README.txt for the changes in the 3.4 branch.
---

02e77d17fae3e9dea5f040375a8ed9ec21259a4b
diff --cc Doc/README.txt
index 4a157d58a6cf,a494c89db6aa..f4f6d81bc9ad
--- a/Doc/README.txt
+++ b/Doc/README.txt
@@@ -3,36 -3,37 +3,34 @@@ Python Documentation READM
  
  This directory contains the reStructuredText (reST) sources to the Python
  documentation.  You don't need to build them yourself, prebuilt versions are
--available at http://docs.python.org/download/.
++available at <http://docs.python.org/download/>.
  
  Documentation on the authoring Python documentation, including information about
  both style and markup, is available in the "Documenting Python" chapter of the
- developers guide (http://docs.python.org/devguide/documenting.html).
- There's also a chapter intended to point out differences to
- those familiar with the previous docs written in LaTeX.
 -documentation.
++developers guide <http://docs.python.org/devguide/documenting.html>.
  
  
  Building the docs
  =================
  
- You need to have Python 2.4 or higher installed; the toolset used to build the
 -You need to have Python 2 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.
++You need to have Sphinx <http://sphinx-doc.org/> installed; it is the toolset
++used to build the docs.  It is not included in this tree, but maintained
++separately and available from PyPI <http://pypi.python.org/pypi/Sphinx>.
  
  
  Using make
  ----------
  
--Luckily, a Makefile has been prepared so that on Unix, provided you have
--installed Python and Subversion, you can just run ::
++A Makefile has been prepared so that on Unix, provided you have installed
++Sphinx, you can just run ::
  
     make html
  
--to check out the necessary toolset in the `tools/` subdirectory and build the
--HTML output files.  To view the generated HTML, point your favorite browser at
--the top-level index `build/html/index.html` after running "make".
++to build the HTML output files.  To view the generated HTML, point your favorite
++browser at the top-level index `build/html/index.html` after running "make".
+ 
+ On Windows, we try to emulate the Makefile as closely as possible with a
+ ``make.bat`` file.
  
  To use a Python interpreter that's not called ``python``, use the standard
  way to set Makefile variables, using e.g. ::
@@@ -74,8 -75,11 +72,9 @@@ Available make targets are
     `tools/sphinxext/pyspecific.py` -- pydoc needs these to show topic and
     keyword help.
  
- A "make update" updates the Subversion checkouts in `tools/`.
+  * "suspicious", which checks the parsed markup for text that looks like
+    malformed and thus unconverted reST.
  
 -A "make update" updates the Subversion checkouts in `tools/`.
 -
  
  Without make
  ------------