Skip to content
Projects
Groups
Snippets
Help
Loading...
Help
Support
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in / Register
Toggle navigation
C
cpython
Project overview
Project overview
Details
Activity
Releases
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Issues
0
Issues
0
List
Boards
Labels
Milestones
Merge Requests
0
Merge Requests
0
Analytics
Analytics
Repository
Value Stream
Wiki
Wiki
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Create a new issue
Commits
Issue Boards
Open sidebar
Kirill Smelkov
cpython
Commits
02e77d17
Commit
02e77d17
authored
Mar 10, 2014
by
Georg Brandl
Browse files
Options
Browse Files
Download
Plain Diff
Closes #20090: update Doc/README.txt for the changes in the 3.4 branch.
parents
b6111f55
18a364fc
Changes
1
Show whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
19 additions
and
43 deletions
+19
-43
Doc/README.txt
Doc/README.txt
+19
-43
No files found.
Doc/README.txt
View file @
02e77d17
...
@@ -3,36 +3,34 @@ Python Documentation README
...
@@ -3,36 +3,34 @@ Python Documentation README
This directory contains the reStructuredText (reST) sources to the Python
This directory contains the reStructuredText (reST) sources to the Python
documentation. You don't need to build them yourself, prebuilt versions are
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
Documentation on the authoring Python documentation, including information about
both style and markup, is available in the "Documenting Python" chapter of the
both style and markup, is available in the "Documenting Python" chapter of the
developers guide (http://docs.python.org/devguide/documenting.html).
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.
Building the docs
Building the docs
=================
=================
You need to have Python 2.4 or higher installed; the toolset used to build the
You need to have Sphinx <http://sphinx-doc.org/> installed; it is the toolset
docs is written in Python. It is called *Sphinx*, it is not included in this
used to build the docs. It is not included in this tree, but maintained
tree, but maintained separately. Also needed are the docutils, supplying the
separately and available from PyPI <http://pypi.python.org/pypi/Sphinx>.
base markup that Sphinx uses, Jinja, a templating engine, and optionally
Pygments, a code highlighter.
Using make
Using make
----------
----------
Luckily, a Makefile has been prepared so that on Unix, provided you have
A Makefile has been prepared so that on Unix, provided you have installed
installed Python and Subversion
, you can just run ::
Sphinx
, you can just run ::
make html
make html
to check out the necessary toolset in the `tools/` subdirectory and build the
to build the HTML output files. To view the generated HTML, point your favorite
HTML output files. To view the generated HTML, point your favorite browser at
browser at the top-level index `build/html/index.html` after running "make".
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
To use a Python interpreter that's not called ``python``, use the standard
way to set Makefile variables, using e.g. ::
way to set Makefile variables, using e.g. ::
...
@@ -74,43 +72,21 @@ Available make targets are:
...
@@ -74,43 +72,21 @@ Available make targets are:
`tools/sphinxext/pyspecific.py` -- pydoc needs these to show topic and
`tools/sphinxext/pyspecific.py` -- pydoc needs these to show topic and
keyword help.
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.
Without make
Without make
------------
------------
You'll need to install the Sphinx package, either by checking it out via ::
Install the Sphinx package and its dependencies from PyPI.
svn co http://svn.python.org/projects/external/Sphinx-1.0.7/sphinx tools/sphinx
or by installing it from PyPI.
Then, you need to install Docutils, either by checking it out via ::
svn co http://svn.python.org/projects/external/docutils-0.6/docutils tools/docutils
or by installing it from http://docutils.sf.net/.
You also need Jinja2, either by checking it out via ::
svn co http://svn.python.org/projects/external/Jinja-2.3.1/jinja2 tools/jinja2
or by installing it from PyPI.
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
or from PyPI at http://pypi.python.org/pypi/Pygments.
Then,
make an output directory, e.g. under `build/`, and
run ::
Then,
from the ``Docs`` directory,
run ::
python tools/sphinx-build.py -b<builder> . build/<outputdirectory
>
sphinx-build -b<builder> . build/<builder
>
where `
<builder>` is one of html, text, latex, or htmlhelp (for explanations see
where `
`<builder>`` is one of html, text, latex, or htmlhelp (for explanations
the make targets above).
see
the make targets above).
Contributing
Contributing
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment