cpython/Doc/README.txt

145 lines
4.8 KiB
Plaintext
Raw Normal View History

2007-08-15 11:28:01 -03:00
Python Documentation README
~~~~~~~~~~~~~~~~~~~~~~~~~~~
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/.
Documentation on the authoring Python documentation, including information about
both style and markup, is available in the "Documenting Python" chapter of the
documentation. There's also a chapter intended to point out differences to
those familiar with the previous docs written in LaTeX.
Building the docs
=================
2010-06-12 06:46:03 -03:00
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.
2007-08-15 11:28:01 -03:00
Using make
----------
Luckily, a Makefile has been prepared so that on Unix, provided you have
installed Python and Subversion, 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".
Available make targets are:
* "html", which builds standalone HTML files for offline viewing.
* "htmlhelp", which builds HTML files and a HTML Help project file usable to
convert them into a single Compiled HTML (.chm) file -- these are popular
under Microsoft Windows, but very handy on every platform.
2010-06-12 06:46:03 -03:00
To create the CHM file, you need to run the Microsoft HTML Help Workshop over
the generated project (.hhp) file.
2007-08-15 11:28:01 -03:00
2010-06-12 06:46:03 -03:00
* "latex", which builds LaTeX source files as input to "pdflatex" to produce
PDF documents.
2008-02-09 19:09:25 -04:00
2008-06-01 13:41:31 -03:00
* "text", which builds a plain text file for each source file.
* "linkcheck", which checks all external references to see whether they are
2010-06-12 06:46:03 -03:00
broken, redirected or malformed, and outputs this information to stdout as
well as a plain-text (.txt) file.
2007-12-29 06:57:00 -04:00
* "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.
2010-06-12 06:46:03 -03:00
* "coverage", which builds a coverage overview for standard library modules and
C API.
2010-06-12 06:46:03 -03:00
* "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.
2007-08-15 11:28:01 -03:00
A "make update" updates the Subversion checkouts in `tools/`.
Without make
------------
2010-03-13 06:54:12 -04:00
You'll need to install the Sphinx package, either by checking it out via ::
2007-08-15 11:28:01 -03:00
2010-03-13 06:54:12 -04:00
svn co http://svn.python.org/projects/external/Sphinx-0.6.5/sphinx tools/sphinx
or by installing it from PyPI.
2007-08-15 11:28:01 -03:00
2008-12-20 21:12:26 -04:00
Then, you need to install Docutils, either by checking it out via ::
2007-08-15 11:28:01 -03:00
2010-03-13 06:54:12 -04:00
svn co http://svn.python.org/projects/external/docutils-0.6/docutils tools/docutils
2007-08-15 11:28:01 -03:00
or by installing it from http://docutils.sf.net/.
You also need Jinja2, either by checking it out via ::
2010-03-13 06:54:12 -04:00
svn co http://svn.python.org/projects/external/Jinja-2.3.1/jinja2 tools/jinja2
or by installing it from PyPI.
2010-06-12 06:46:03 -03:00
You can optionally also install Pygments, either as a checkout via ::
2007-08-15 11:28:01 -03:00
2010-03-13 06:54:12 -04:00
svn co http://svn.python.org/projects/external/Pygments-1.3.1/pygments tools/pygments
2007-08-15 11:28:01 -03:00
or from PyPI at http://pypi.python.org/pypi/Pygments.
Then, make an output directory, e.g. under `build/`, and run ::
python tools/sphinx-build.py -b<builder> . build/<outputdirectory>
2008-12-20 21:04:32 -04:00
where `<builder>` is one of html, text, latex, or htmlhelp (for explanations see
the make targets above).
2007-08-15 11:28:01 -03:00
Contributing
============
2008-12-20 21:12:26 -04:00
Bugs in the content should be reported to the Python bug tracker at
http://bugs.python.org.
2007-08-15 11:28:01 -03:00
2008-12-20 21:12:26 -04:00
Bugs in the toolset should be reported in the Sphinx bug tracker at
http://www.bitbucket.org/birkenfeld/sphinx/issues/.
2007-08-15 11:28:01 -03:00
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.
If you want to help the Documentation Team, you are always welcome. Just send
a mail to docs@python.org.
Copyright notice
================
The Python source is copyrighted, but you can freely use and copy it
as long as you don't change or remove the copyright notice:
----------------------------------------------------------------------
Copyright (c) 2000-2008 Python Software Foundation.
2007-08-15 11:28:01 -03:00
All rights reserved.
Copyright (c) 2000 BeOpen.com.
All rights reserved.
Copyright (c) 1995-2000 Corporation for National Research Initiatives.
All rights reserved.
Copyright (c) 1991-1995 Stichting Mathematisch Centrum.
All rights reserved.
See the file "license.rst" for information on usage and redistribution
of this file, and for a DISCLAIMER OF ALL WARRANTIES.
----------------------------------------------------------------------