mirror of
https://github.com/python/cpython.git
synced 2025-09-18 14:40:43 +00:00
Fixing broken links in doc, part 1: faq/
This commit is contained in:
parent
728e4debd8
commit
77fe77d4af
9 changed files with 26 additions and 33 deletions
|
@ -68,7 +68,7 @@ taken on the bug.
|
||||||
Article which goes into some detail about how to create a useful bug report.
|
Article which goes into some detail about how to create a useful bug report.
|
||||||
This describes what kind of information is useful and why it is useful.
|
This describes what kind of information is useful and why it is useful.
|
||||||
|
|
||||||
`Bug Writing Guidelines <http://developer.mozilla.org/en/docs/Bug_writing_guidelines>`_
|
`Bug Writing Guidelines <https://developer.mozilla.org/en-US/docs/Mozilla/QA/Bug_writing_guidelines>`_
|
||||||
Information about writing a good bug report. Some of this is specific to the
|
Information about writing a good bug report. Some of this is specific to the
|
||||||
Mozilla project, but describes general good practices.
|
Mozilla project, but describes general good practices.
|
||||||
|
|
||||||
|
|
|
@ -244,4 +244,4 @@ without warnings does not guarantee that PyPI will convert the content
|
||||||
successfully.
|
successfully.
|
||||||
|
|
||||||
|
|
||||||
.. _Python Package Index (PyPI): https://pypi.python.org/
|
.. _Python Package Index (PyPI): https://pypi.python.org/pypi
|
||||||
|
|
|
@ -368,9 +368,9 @@ Can Python be compiled to machine code, C or some other language?
|
||||||
|
|
||||||
Practical answer:
|
Practical answer:
|
||||||
|
|
||||||
`Cython <http://cython.org/>`_ and `Pyrex <http://www.cosc.canterbury.ac.nz/~greg/python/Pyrex/>`_
|
`Cython <http://cython.org/>`_ and `Pyrex <http://www.cosc.canterbury.ac.nz/greg.ewing/python/Pyrex/>`_
|
||||||
compile a modified version of Python with optional annotations into C
|
compile a modified version of Python with optional annotations into C
|
||||||
extensions. `Weave <http://www.scipy.org/Weave>`_ makes it easy to
|
extensions. `Weave <http://docs.scipy.org/doc/scipy-dev/reference/tutorial/weave.html>`_ makes it easy to
|
||||||
intermingle Python and C code in various ways to increase performance.
|
intermingle Python and C code in various ways to increase performance.
|
||||||
`Nuitka <http://www.nuitka.net/>`_ is an up-and-coming compiler of Python
|
`Nuitka <http://www.nuitka.net/>`_ is an up-and-coming compiler of Python
|
||||||
into C++ code, aiming to support the full Python language.
|
into C++ code, aiming to support the full Python language.
|
||||||
|
@ -392,7 +392,7 @@ approach is feasible, although the speedups reached so far are only modest
|
||||||
Hugunin has demonstrated that in combination with whole-program analysis,
|
Hugunin has demonstrated that in combination with whole-program analysis,
|
||||||
speedups of 1000x are feasible for small demo programs. See the proceedings
|
speedups of 1000x are feasible for small demo programs. See the proceedings
|
||||||
from the `1997 Python conference
|
from the `1997 Python conference
|
||||||
<https://www.python.org/workshops/1997-10/proceedings/>`_ for more information.)
|
<http://legacy.python.org/workshops/1997-10/proceedings/>`_ for more information.)
|
||||||
|
|
||||||
|
|
||||||
How does Python manage memory?
|
How does Python manage memory?
|
||||||
|
|
|
@ -42,7 +42,7 @@ on what you're trying to do.
|
||||||
.. XXX make sure these all work
|
.. XXX make sure these all work
|
||||||
|
|
||||||
`Cython <http://cython.org>`_ and its relative `Pyrex
|
`Cython <http://cython.org>`_ and its relative `Pyrex
|
||||||
<http://www.cosc.canterbury.ac.nz/~greg/python/Pyrex/>`_ are compilers
|
<http://www.cosc.canterbury.ac.nz/greg.ewing/python/Pyrex/>`_ are compilers
|
||||||
that accept a slightly modified form of Python and generate the corresponding
|
that accept a slightly modified form of Python and generate the corresponding
|
||||||
C code. Cython and Pyrex make it possible to write an extension without having
|
C code. Cython and Pyrex make it possible to write an extension without having
|
||||||
to learn Python's C API.
|
to learn Python's C API.
|
||||||
|
@ -53,8 +53,8 @@ with a tool such as `SWIG <http://www.swig.org>`_. `SIP
|
||||||
<http://www.riverbankcomputing.co.uk/software/sip/>`__, `CXX
|
<http://www.riverbankcomputing.co.uk/software/sip/>`__, `CXX
|
||||||
<http://cxx.sourceforge.net/>`_ `Boost
|
<http://cxx.sourceforge.net/>`_ `Boost
|
||||||
<http://www.boost.org/libs/python/doc/index.html>`_, or `Weave
|
<http://www.boost.org/libs/python/doc/index.html>`_, or `Weave
|
||||||
<http://www.scipy.org/Weave>`_ are also alternatives for wrapping
|
<http://docs.scipy.org/doc/scipy-dev/reference/tutorial/weave.html>`_ are also
|
||||||
C++ libraries.
|
alternatives for wrapping C++ libraries.
|
||||||
|
|
||||||
|
|
||||||
How can I execute arbitrary Python statements from C?
|
How can I execute arbitrary Python statements from C?
|
||||||
|
|
|
@ -223,8 +223,8 @@ releases are announced on the comp.lang.python and comp.lang.python.announce
|
||||||
newsgroups and on the Python home page at https://www.python.org/; an RSS feed of
|
newsgroups and on the Python home page at https://www.python.org/; an RSS feed of
|
||||||
news is available.
|
news is available.
|
||||||
|
|
||||||
You can also access the development version of Python through Subversion. See
|
You can also access the development version of Python through Mercurial. See
|
||||||
https://docs.python.org/devguide/faq for details.
|
https://docs.python.org/devguide/faq.html for details.
|
||||||
|
|
||||||
|
|
||||||
How do I submit bug reports and patches for Python?
|
How do I submit bug reports and patches for Python?
|
||||||
|
@ -284,7 +284,7 @@ Why is it called Python?
|
||||||
|
|
||||||
When he began implementing Python, Guido van Rossum was also reading the
|
When he began implementing Python, Guido van Rossum was also reading the
|
||||||
published scripts from `"Monty Python's Flying Circus"
|
published scripts from `"Monty Python's Flying Circus"
|
||||||
<http://pythonline.com/>`__, a BBC comedy series from the 1970s. Van Rossum
|
<http://en.wikipedia.org/wiki/Monty_Python>`__, a BBC comedy series from the 1970s. Van Rossum
|
||||||
thought he needed a name that was short, unique, and slightly mysterious, so he
|
thought he needed a name that was short, unique, and slightly mysterious, so he
|
||||||
decided to call the language Python.
|
decided to call the language Python.
|
||||||
|
|
||||||
|
@ -313,7 +313,7 @@ guaranteed that interfaces will remain the same throughout a series of bugfix
|
||||||
releases.
|
releases.
|
||||||
|
|
||||||
The latest stable releases can always be found on the `Python download page
|
The latest stable releases can always be found on the `Python download page
|
||||||
<https://python.org/download/>`_. There are two recommended production-ready
|
<https://www.python.org/download/>`_. There are two recommended production-ready
|
||||||
versions at this point in time, because at the moment there are two branches of
|
versions at this point in time, because at the moment there are two branches of
|
||||||
stable releases: 2.x and 3.x. Python 3.x may be less useful than 2.x, since
|
stable releases: 2.x and 3.x. Python 3.x may be less useful than 2.x, since
|
||||||
currently there is more third party software available for Python 2 than for
|
currently there is more third party software available for Python 2 than for
|
||||||
|
@ -337,9 +337,9 @@ the group or even read it.
|
||||||
Have any significant projects been done in Python?
|
Have any significant projects been done in Python?
|
||||||
--------------------------------------------------
|
--------------------------------------------------
|
||||||
|
|
||||||
See https://python.org/about/success for a list of projects that use Python.
|
See https://www.python.org/about/success for a list of projects that use Python.
|
||||||
Consulting the proceedings for `past Python conferences
|
Consulting the proceedings for `past Python conferences
|
||||||
<https://python.org/community/workshops/>`_ will reveal contributions from many
|
<https://www.python.org/community/workshops/>`_ will reveal contributions from many
|
||||||
different companies and organizations.
|
different companies and organizations.
|
||||||
|
|
||||||
High-profile Python projects include `the Mailman mailing list manager
|
High-profile Python projects include `the Mailman mailing list manager
|
||||||
|
|
|
@ -59,13 +59,13 @@ Qt
|
||||||
|
|
||||||
There are bindings available for the Qt toolkit (using either `PyQt
|
There are bindings available for the Qt toolkit (using either `PyQt
|
||||||
<http://www.riverbankcomputing.co.uk/software/pyqt/>`_ or `PySide
|
<http://www.riverbankcomputing.co.uk/software/pyqt/>`_ or `PySide
|
||||||
<http://www.pyside.org/>`_) and for KDE (`PyKDE <http://www.riverbankcomputing.co.uk/software/pykde/intro>`__).
|
<http://www.pyside.org/>`_) and for KDE (`PyKDE <https://techbase.kde.org/Development/Languages/Python>`__).
|
||||||
PyQt is currently more mature than PySide, but you must buy a PyQt license from
|
PyQt is currently more mature than PySide, but you must buy a PyQt license from
|
||||||
`Riverbank Computing <http://www.riverbankcomputing.co.uk/software/pyqt/license>`_
|
`Riverbank Computing <http://www.riverbankcomputing.co.uk/software/pyqt/license>`_
|
||||||
if you want to write proprietary applications. PySide is free for all applications.
|
if you want to write proprietary applications. PySide is free for all applications.
|
||||||
|
|
||||||
Qt 4.5 upwards is licensed under the LGPL license; also, commercial licenses
|
Qt 4.5 upwards is licensed under the LGPL license; also, commercial licenses
|
||||||
are available from `Nokia <http://qt.nokia.com/>`_.
|
are available from `The Qt Company <http://www.qt.io/licensing/>`_.
|
||||||
|
|
||||||
Gtk+
|
Gtk+
|
||||||
----
|
----
|
||||||
|
@ -103,7 +103,7 @@ What platform-specific GUI toolkits exist for Python?
|
||||||
========================================================
|
========================================================
|
||||||
|
|
||||||
By installing the `PyObjc Objective-C bridge
|
By installing the `PyObjc Objective-C bridge
|
||||||
<http://pyobjc.sourceforge.net>`_, Python programs can use Mac OS X's
|
<https://pythonhosted.org/pyobjc/>`_, Python programs can use Mac OS X's
|
||||||
Cocoa libraries.
|
Cocoa libraries.
|
||||||
|
|
||||||
:ref:`Pythonwin <windows-faq>` by Mark Hammond includes an interface to the
|
:ref:`Pythonwin <windows-faq>` by Mark Hammond includes an interface to the
|
||||||
|
|
|
@ -182,7 +182,7 @@ How do I create documentation from doc strings?
|
||||||
The :mod:`pydoc` module can create HTML from the doc strings in your Python
|
The :mod:`pydoc` module can create HTML from the doc strings in your Python
|
||||||
source code. An alternative for creating API documentation purely from
|
source code. An alternative for creating API documentation purely from
|
||||||
docstrings is `epydoc <http://epydoc.sf.net/>`_. `Sphinx
|
docstrings is `epydoc <http://epydoc.sf.net/>`_. `Sphinx
|
||||||
<http://sphinx.pocoo.org>`_ can also include docstring content.
|
<http://sphinx-doc.org>`_ can also include docstring content.
|
||||||
|
|
||||||
|
|
||||||
How do I get a single keypress at a time?
|
How do I get a single keypress at a time?
|
||||||
|
|
|
@ -30,7 +30,7 @@ Pythonwin debugger colors breakpoints and has quite a few cool features such as
|
||||||
debugging non-Pythonwin programs. Pythonwin is available as part of the `Python
|
debugging non-Pythonwin programs. Pythonwin is available as part of the `Python
|
||||||
for Windows Extensions <http://sourceforge.net/projects/pywin32/>`__ project and
|
for Windows Extensions <http://sourceforge.net/projects/pywin32/>`__ project and
|
||||||
as a part of the ActivePython distribution (see
|
as a part of the ActivePython distribution (see
|
||||||
http://www.activestate.com/Products/ActivePython/index.html).
|
http://www.activestate.com/activepython\ ).
|
||||||
|
|
||||||
`Boa Constructor <http://boa-constructor.sourceforge.net/>`_ is an IDE and GUI
|
`Boa Constructor <http://boa-constructor.sourceforge.net/>`_ is an IDE and GUI
|
||||||
builder that uses wxWidgets. It offers visual frame creation and manipulation,
|
builder that uses wxWidgets. It offers visual frame creation and manipulation,
|
||||||
|
@ -38,7 +38,7 @@ an object inspector, many views on the source like object browsers, inheritance
|
||||||
hierarchies, doc string generated html documentation, an advanced debugger,
|
hierarchies, doc string generated html documentation, an advanced debugger,
|
||||||
integrated help, and Zope support.
|
integrated help, and Zope support.
|
||||||
|
|
||||||
`Eric <http://www.die-offenbachs.de/eric/index.html>`_ is an IDE built on PyQt
|
`Eric <http://eric-ide.python-projects.org/>`_ is an IDE built on PyQt
|
||||||
and the Scintilla editing component.
|
and the Scintilla editing component.
|
||||||
|
|
||||||
Pydb is a version of the standard Python debugger pdb, modified for use with DDD
|
Pydb is a version of the standard Python debugger pdb, modified for use with DDD
|
||||||
|
@ -50,7 +50,7 @@ There are a number of commercial Python IDEs that include graphical debuggers.
|
||||||
They include:
|
They include:
|
||||||
|
|
||||||
* Wing IDE (http://wingware.com/)
|
* Wing IDE (http://wingware.com/)
|
||||||
* Komodo IDE (http://www.activestate.com/Products/Komodo)
|
* Komodo IDE (http://komodoide.com/)
|
||||||
* PyCharm (https://www.jetbrains.com/pycharm/)
|
* PyCharm (https://www.jetbrains.com/pycharm/)
|
||||||
|
|
||||||
|
|
||||||
|
@ -69,8 +69,7 @@ plug-ins to add a custom feature. In addition to the bug checking that
|
||||||
PyChecker performs, Pylint offers some additional features such as checking line
|
PyChecker performs, Pylint offers some additional features such as checking line
|
||||||
length, whether variable names are well-formed according to your coding
|
length, whether variable names are well-formed according to your coding
|
||||||
standard, whether declared interfaces are fully implemented, and more.
|
standard, whether declared interfaces are fully implemented, and more.
|
||||||
http://www.logilab.org/card/pylint_manual provides a full list of Pylint's
|
http://docs.pylint.org/ provides a full list of Pylint's features.
|
||||||
features.
|
|
||||||
|
|
||||||
|
|
||||||
How can I create a stand-alone binary from a Python script?
|
How can I create a stand-alone binary from a Python script?
|
||||||
|
@ -101,13 +100,7 @@ which don't. One is Thomas Heller's py2exe (Windows only) at
|
||||||
|
|
||||||
http://www.py2exe.org/
|
http://www.py2exe.org/
|
||||||
|
|
||||||
Another is Christian Tismer's `SQFREEZE <http://starship.python.net/crew/pirx>`_
|
Another tool is Anthony Tuininga's `cx_Freeze <http://cx-freeze.sourceforge.net/>`_.
|
||||||
which appends the byte code to a specially-prepared Python interpreter that can
|
|
||||||
find the byte code in the executable.
|
|
||||||
|
|
||||||
Other tools include Fredrik Lundh's `Squeeze
|
|
||||||
<http://www.pythonware.com/products/python/squeeze>`_ and Anthony Tuininga's
|
|
||||||
`cx_Freeze <http://starship.python.net/crew/atuining/cx_Freeze/index.html>`_.
|
|
||||||
|
|
||||||
|
|
||||||
Are there coding standards or a style guide for Python programs?
|
Are there coding standards or a style guide for Python programs?
|
||||||
|
@ -1125,7 +1118,7 @@ How do you remove duplicates from a list?
|
||||||
|
|
||||||
See the Python Cookbook for a long discussion of many ways to do this:
|
See the Python Cookbook for a long discussion of many ways to do this:
|
||||||
|
|
||||||
http://aspn.activestate.com/ASPN/Cookbook/Python/Recipe/52560
|
http://code.activestate.com/recipes/52560/
|
||||||
|
|
||||||
If you don't mind reordering the list, sort it and then scan from the end of the
|
If you don't mind reordering the list, sort it and then scan from the end of the
|
||||||
list, deleting duplicates as you go::
|
list, deleting duplicates as you go::
|
||||||
|
|
|
@ -31,7 +31,7 @@ obvious; otherwise, you might need a little more guidance.
|
||||||
|
|
||||||
.. |Python Development on XP| image:: python-video-icon.png
|
.. |Python Development on XP| image:: python-video-icon.png
|
||||||
.. _`Python Development on XP`:
|
.. _`Python Development on XP`:
|
||||||
http://www.showmedo.com/videos/series?name=pythonOzsvaldPyNewbieSeries
|
http://showmedo.com/videotutorials/series?name=pythonOzsvaldPyNewbieSeries
|
||||||
|
|
||||||
Unless you use some sort of integrated development environment, you will end up
|
Unless you use some sort of integrated development environment, you will end up
|
||||||
*typing* Windows commands into what is variously referred to as a "DOS window"
|
*typing* Windows commands into what is variously referred to as a "DOS window"
|
||||||
|
@ -105,7 +105,7 @@ gives you a message like::
|
||||||
|
|
||||||
.. |Adding Python to DOS Path| image:: python-video-icon.png
|
.. |Adding Python to DOS Path| image:: python-video-icon.png
|
||||||
.. _`Adding Python to DOS Path`:
|
.. _`Adding Python to DOS Path`:
|
||||||
http://showmedo.com/videos/video?name=960000&fromSeriesID=96
|
http://showmedo.com/videotutorials/video?name=960000&fromSeriesID=96
|
||||||
|
|
||||||
|
|
||||||
or::
|
or::
|
||||||
|
|
Loading…
Add table
Add a link
Reference in a new issue