mirror of
https://github.com/python/cpython.git
synced 2025-07-24 11:44:31 +00:00
7b82b40a47
svn+ssh://pythondev@svn.python.org/python/trunk ........ r72487 | jeffrey.yasskin | 2009-05-08 17:51:06 -0400 (Fri, 08 May 2009) | 7 lines PyCode_NewEmpty: Most uses of PyCode_New found by http://www.google.com/codesearch?q=PyCode_New are trying to build an empty code object, usually to put it in a dummy frame object. This patch adds a PyCode_NewEmpty wrapper which lets the user specify just the filename, function name, and first line number, instead of also requiring lots of code internals. ........ r72488 | jeffrey.yasskin | 2009-05-08 18:23:21 -0400 (Fri, 08 May 2009) | 13 lines Issue 5954, PyFrame_GetLineNumber: Most uses of PyCode_Addr2Line (http://www.google.com/codesearch?q=PyCode_Addr2Line) are just trying to get the line number of a specified frame, but there's no way to do that directly. Forcing people to go through the code object makes them know more about the guts of the interpreter than they should need. The remaining uses of PyCode_Addr2Line seem to be getting the line from a traceback (for example, http://www.google.com/codesearch/p?hl=en#u_9_nDrchrw/pygame-1.7.1release/src/base.c&q=PyCode_Addr2Line), which is replaced by the tb_lineno field. So we may be able to deprecate PyCode_Addr2Line entirely for external use. ........ r72879 | jeffrey.yasskin | 2009-05-23 19:23:01 -0400 (Sat, 23 May 2009) | 14 lines Issue #6042: lnotab-based tracing is very complicated and isn't documented very well. There were at least 3 comment blocks purporting to document co_lnotab, and none did a very good job. This patch unifies them into Objects/lnotab_notes.txt which tries to completely capture the current state of affairs. I also discovered that we've attached 2 layers of patches to the basic tracing scheme. The first layer avoids jumping to instructions that don't start a line, to avoid problems in if statements and while loops. The second layer discovered that jumps backward do need to trace at instructions that don't start a line, so it added extra lnotab entries for 'while' and 'for' loops, and added a special case for backward jumps within the same line. I replaced these patches by just treating forward and backward jumps differently. ........ |
||
|---|---|---|
| .. | ||
| c-api | ||
| data | ||
| distutils | ||
| documenting | ||
| extending | ||
| howto | ||
| includes | ||
| install | ||
| library | ||
| reference | ||
| tools | ||
| tutorial | ||
| using | ||
| whatsnew | ||
| about.rst | ||
| ACKS.txt | ||
| bugs.rst | ||
| conf.py | ||
| contents.rst | ||
| copyright.rst | ||
| glossary.rst | ||
| license.rst | ||
| make.bat | ||
| Makefile | ||
| README.txt | ||
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 ================= You need to install Python 2.4 or higher (but Python 3.0 is not supported yet); 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. 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". To use a Python interpreter that's not called ``python``, use the standard way to set Makefile variables, using e.g. :: make html PYTHON=/usr/bin/python2.5 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. 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. * "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. * "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. * "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/`. Without make ------------ You'll need to checkout the Sphinx package to the `tools/` directory:: svn co http://svn.python.org/projects/external/Sphinx-0.6.1/sphinx tools/sphinx Then, you need to install Docutils, either by checking it out via :: svn co http://svn.python.org/projects/external/docutils-0.5/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.1.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-0.11.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 :: python tools/sphinx-build.py -b<builder> . build/<outputdirectory> where `<builder>` is one of html, text, latex, or htmlhelp (for explanations see the make targets above). Contributing ============ Bugs in the content should be reported to the Python bug tracker at http://bugs.python.org. Bugs in the toolset should be reported in the Sphinx bug tracker at http://www.bitbucket.org/birkenfeld/sphinx/issues/. 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. 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. ----------------------------------------------------------------------