Skip to content

Commit af13a63

Browse files
Sorry
0 parents  commit af13a63

File tree

3,859 files changed

+1778593
-0
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

3,859 files changed

+1778593
-0
lines changed

.gitignore

Lines changed: 79 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,79 @@
1+
# Two-trick pony for OSX and other case insensitive file systems:
2+
# Ignore ./python binary on Unix but still look into ./Python/ directory.
3+
/python
4+
!/Python/**
5+
*.cover
6+
*.o
7+
*.orig
8+
*.pyc
9+
*.pyd
10+
*.pyo
11+
*.rej
12+
*.swp
13+
*~
14+
.gdb_history
15+
Doc/build/
16+
Doc/tools/docutils/
17+
Doc/tools/jinja/
18+
Doc/tools/jinja2/
19+
Doc/tools/pygments/
20+
Doc/tools/sphinx/
21+
Lib/lib2to3/*.pickle
22+
Lib/test/data/*
23+
Lib/_sysconfigdata.py
24+
Lib/plat-mac/errors.rsrc.df.rsrc
25+
Makefile
26+
Makefile.pre
27+
Misc/python.pc
28+
Misc/python-config.sh
29+
Modules/Setup
30+
Modules/Setup.config
31+
Modules/Setup.local
32+
Modules/config.c
33+
Modules/ld_so_aix
34+
Modules/_freeze_importlib
35+
Modules/_testembed
36+
PCbuild/*.bsc
37+
PCbuild/*.dll
38+
PCbuild/*.exe
39+
PCbuild/*.exp
40+
PCbuild/*.lib
41+
PCbuild/*.ncb
42+
PCbuild/*.o
43+
PCbuild/*.pdb
44+
PCbuild/Win32-temp-*
45+
PCbuild/amd64/
46+
.purify
47+
Parser/pgen
48+
__pycache__
49+
autom4te.cache
50+
build/
51+
buildno
52+
config.cache
53+
config.log
54+
config.status
55+
config.status.lineno
56+
core
57+
db_home
58+
config.log
59+
config.status
60+
libpython*.a
61+
libpython*.so*
62+
platform
63+
pybuilddir.txt
64+
pyconfig.h
65+
python-config
66+
python-config.py
67+
python.exe
68+
python-gdb.py
69+
python.exe-gdb.py
70+
setonas.exe
71+
setonas.exe-gdb.py
72+
reflog.txt
73+
.svn/
74+
tags
75+
TAGS
76+
.coverage
77+
coverage/
78+
externals/
79+
htmlcov/

.travis.yml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
before_install:
2+
- sudo apt-get -qq update
3+
- sudo apt-get install -y libxml2-dev gcc make automake build-essential g++ cmake
4+
script:
5+
- ./configure && make && ls && ./setonas test.se

CNAME

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
setonas.org

Doc/README.txt

Lines changed: 121 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,121 @@
1+
Python Documentation README
2+
~~~~~~~~~~~~~~~~~~~~~~~~~~~
3+
4+
This directory contains the reStructuredText (reST) sources to the Python
5+
documentation. You don't need to build them yourself, prebuilt versions are
6+
available at <https://docs.python.org/3.4/download.html>.
7+
8+
Documentation on authoring Python documentation, including information about
9+
both style and markup, is available in the "Documenting Python" chapter of the
10+
developers guide <https://docs.python.org/devguide/documenting.html>.
11+
12+
13+
Building the docs
14+
=================
15+
16+
You need to have Sphinx <http://sphinx-doc.org/> installed; it is the toolset
17+
used to build the docs. It is not included in this tree, but maintained
18+
separately and available from PyPI <https://pypi.python.org/pypi/Sphinx>.
19+
20+
21+
Using make
22+
----------
23+
24+
A Makefile has been prepared so that on Unix, provided you have installed
25+
Sphinx, you can just run ::
26+
27+
make html
28+
29+
to build the HTML output files.
30+
31+
On Windows, we try to emulate the Makefile as closely as possible with a
32+
``make.bat`` file.
33+
34+
To use a Python interpreter that's not called ``python``, use the standard
35+
way to set Makefile variables, using e.g. ::
36+
37+
make html PYTHON=python3
38+
39+
On Windows, set the PYTHON environment variable instead.
40+
41+
To use a specific sphinx-build (something other than ``sphinx-build``), set
42+
the SPHINXBUILD variable.
43+
44+
Available make targets are:
45+
46+
* "clean", which removes all build files.
47+
48+
* "html", which builds standalone HTML files for offline viewing.
49+
50+
* "htmlview", which re-uses the "html" builder, but then opens the main page
51+
in your default web browser.
52+
53+
* "htmlhelp", which builds HTML files and a HTML Help project file usable to
54+
convert them into a single Compiled HTML (.chm) file -- these are popular
55+
under Microsoft Windows, but very handy on every platform.
56+
57+
To create the CHM file, you need to run the Microsoft HTML Help Workshop
58+
over the generated project (.hhp) file. The make.bat script does this for
59+
you on Windows.
60+
61+
* "latex", which builds LaTeX source files as input to "pdflatex" to produce
62+
PDF documents.
63+
64+
* "text", which builds a plain text file for each source file.
65+
66+
* "epub", which builds an EPUB document, suitable to be viewed on e-book
67+
readers.
68+
69+
* "linkcheck", which checks all external references to see whether they are
70+
broken, redirected or malformed, and outputs this information to stdout as
71+
well as a plain-text (.txt) file.
72+
73+
* "changes", which builds an overview over all versionadded/versionchanged/
74+
deprecated items in the current version. This is meant as a help for the
75+
writer of the "What's New" document.
76+
77+
* "coverage", which builds a coverage overview for standard library modules and
78+
C API.
79+
80+
* "pydoc-topics", which builds a Python module containing a dictionary with
81+
plain text documentation for the labels defined in
82+
`tools/pyspecific.py` -- pydoc needs these to show topic and keyword help.
83+
84+
* "suspicious", which checks the parsed markup for text that looks like
85+
malformed and thus unconverted reST.
86+
87+
* "check", which checks for frequent markup errors.
88+
89+
* "serve", which serves the build/html directory on port 8000.
90+
91+
* "dist", (Unix only) which creates distributable archives of HTML, text,
92+
PDF, and EPUB builds.
93+
94+
95+
Without make
96+
------------
97+
98+
Install the Sphinx package and its dependencies from PyPI.
99+
100+
Then, from the ``Doc`` directory, run ::
101+
102+
sphinx-build -b<builder> . build/<builder>
103+
104+
where ``<builder>`` is one of html, text, latex, or htmlhelp (for explanations
105+
see the make targets above).
106+
107+
108+
Contributing
109+
============
110+
111+
Bugs in the content should be reported to the Python bug tracker at
112+
https://bugs.python.org.
113+
114+
Bugs in the toolset should be reported in the Sphinx bug tracker at
115+
https://www.bitbucket.org/birkenfeld/sphinx/issues/.
116+
117+
You can also send a mail to the Python Documentation Team at docs@python.org,
118+
and we will process your request as soon as possible.
119+
120+
If you want to help the Documentation Team, you are always welcome. Just send
121+
a mail to docs@python.org.

Doc/about.rst

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
=====================
2+
About these documents
3+
=====================
4+
5+
6+
These documents are generated from `reStructuredText`_ sources by `Sphinx`_, a
7+
document processor specifically written for the Python documentation.
8+
9+
.. _reStructuredText: http://docutils.sourceforge.net/rst.html
10+
.. _Sphinx: http://sphinx-doc.org/
11+
12+
.. In the online version of these documents, you can submit comments and suggest
13+
changes directly on the documentation pages.
14+
15+
Development of the documentation and its toolchain is an entirely volunteer
16+
effort, just like Python itself. If you want to contribute, please take a
17+
look at the :ref:`reporting-bugs` page for information on how to do so. New
18+
volunteers are always welcome!
19+
20+
Many thanks go to:
21+
22+
* Fred L. Drake, Jr., the creator of the original Python documentation toolset
23+
and writer of much of the content;
24+
* the `Docutils <http://docutils.sourceforge.net/>`_ project for creating
25+
reStructuredText and the Docutils suite;
26+
* Fredrik Lundh for his `Alternative Python Reference
27+
<http://effbot.org/zone/pyref.htm>`_ project from which Sphinx got many good
28+
ideas.
29+
30+
31+
Contributors to the Python Documentation
32+
----------------------------------------
33+
34+
Many people have contributed to the Python language, the Python standard
35+
library, and the Python documentation. See :source:`Misc/ACKS` in the Python
36+
source distribution for a partial list of contributors.
37+
38+
It is only with the input and contributions of the Python community
39+
that Python has such wonderful documentation -- Thank You!

Doc/bugs.rst

Lines changed: 87 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,87 @@
1+
.. _reporting-bugs:
2+
3+
**************
4+
Reporting Bugs
5+
**************
6+
7+
Python is a mature programming language which has established a reputation for
8+
stability. In order to maintain this reputation, the developers would like to
9+
know of any deficiencies you find in Python.
10+
11+
12+
Documentation bugs
13+
==================
14+
15+
If you find a bug in this documentation or would like to propose an improvement,
16+
please submit a bug report on the :ref:`tracker <using-the-tracker>`. If you
17+
have a suggestion how to fix it, include that as well.
18+
19+
If you're short on time, you can also email your bug report to docs@python.org.
20+
'docs@' is a mailing list run by volunteers; your request will be noticed,
21+
though it may take a while to be processed.
22+
23+
.. seealso::
24+
`Documentation bugs`_ on the Python issue tracker
25+
26+
.. _using-the-tracker:
27+
28+
Using the Python issue tracker
29+
==============================
30+
31+
Bug reports for Python itself should be submitted via the Python Bug Tracker
32+
(https://bugs.python.org/). The bug tracker offers a Web form which allows
33+
pertinent information to be entered and submitted to the developers.
34+
35+
The first step in filing a report is to determine whether the problem has
36+
already been reported. The advantage in doing so, aside from saving the
37+
developers time, is that you learn what has been done to fix it; it may be that
38+
the problem has already been fixed for the next release, or additional
39+
information is needed (in which case you are welcome to provide it if you can!).
40+
To do this, search the bug database using the search box on the top of the page.
41+
42+
If the problem you're reporting is not already in the bug tracker, go back to
43+
the Python Bug Tracker and log in. If you don't already have a tracker account,
44+
select the "Register" link or, if you use OpenID, one of the OpenID provider
45+
logos in the sidebar. It is not possible to submit a bug report anonymously.
46+
47+
Being now logged in, you can submit a bug. Select the "Create New" link in the
48+
sidebar to open the bug reporting form.
49+
50+
The submission form has a number of fields. For the "Title" field, enter a
51+
*very* short description of the problem; less than ten words is good. In the
52+
"Type" field, select the type of your problem; also select the "Component" and
53+
"Versions" to which the bug relates.
54+
55+
In the "Comment" field, describe the problem in detail, including what you
56+
expected to happen and what did happen. Be sure to include whether any
57+
extension modules were involved, and what hardware and software platform you
58+
were using (including version information as appropriate).
59+
60+
Each bug report will be assigned to a developer who will determine what needs to
61+
be done to correct the problem. You will receive an update each time action is
62+
taken on the bug.
63+
64+
65+
.. seealso::
66+
67+
`How to Report Bugs Effectively <http://www.chiark.greenend.org.uk/~sgtatham/bugs.html>`_
68+
Article which goes into some detail about how to create a useful bug report.
69+
This describes what kind of information is useful and why it is useful.
70+
71+
`Bug Writing Guidelines <https://developer.mozilla.org/en-US/docs/Mozilla/QA/Bug_writing_guidelines>`_
72+
Information about writing a good bug report. Some of this is specific to the
73+
Mozilla project, but describes general good practices.
74+
75+
76+
Getting started contributing to Python yourself
77+
===============================================
78+
79+
Beyond just reporting bugs that you find, you are also welcome to submit
80+
patches to fix them. You can find more information on how to get started
81+
patching Python in the `Python Developer's Guide`_. If you have questions,
82+
the `core-mentorship mailing list`_ is a friendly place to get answers to
83+
any and all questions pertaining to the process of fixing issues in Python.
84+
85+
.. _Documentation bugs: https://bugs.python.org/issue?@filter=status&@filter=components&components=4&status=1&@columns=id,activity,title,status&@sort=-activity
86+
.. _Python Developer's Guide: https://docs.python.org/devguide/
87+
.. _core-mentorship mailing list: https://mail.python.org/mailman/listinfo/core-mentorship/

Doc/c-api/abstract.rst

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
.. highlightlang:: c
2+
3+
.. _abstract:
4+
5+
**********************
6+
Abstract Objects Layer
7+
**********************
8+
9+
The functions in this chapter interact with Python objects regardless of their
10+
type, or with wide classes of object types (e.g. all numerical types, or all
11+
sequence types). When used on object types for which they do not apply, they
12+
will raise a Python exception.
13+
14+
It is not possible to use these functions on objects that are not properly
15+
initialized, such as a list object that has been created by :c:func:`PyList_New`,
16+
but whose items have not been set to some non-\ ``NULL`` value yet.
17+
18+
.. toctree::
19+
20+
object.rst
21+
number.rst
22+
sequence.rst
23+
mapping.rst
24+
iter.rst
25+
buffer.rst
26+
objbuffer.rst

0 commit comments

Comments
 (0)