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
f084aed3
Commit
f084aed3
authored
Jun 12, 2010
by
Georg Brandl
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Update README.
parent
961e6fd3
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
18 additions
and
19 deletions
+18
-19
Doc/README.txt
Doc/README.txt
+18
-19
No files found.
Doc/README.txt
View file @
f084aed3
...
...
@@ -14,12 +14,11 @@ those familiar with the previous docs written in LaTeX.
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 @@ Available make targets are:
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 @@ You also need Jinja2, either by checking it out via ::
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
...
...
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