◐ Shell
reader mode source ↗
Skip to content
Merged

[3.6] Backport README.rst changes #294

Show file tree
Hide file tree
Changes from all commits
File filter
Conversations
Jump to
Diff view
Apply and reload
Show whitespace
Diff view
Apply and reload
2 changes: 1 addition & 1 deletion Doc/Makefile
View file Edit file Delete file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -153,7 +153,7 @@ dist:
cp -pPR build/epub/Python.epub dist/python-$(DISTVERSION)-docs.epub

check:
$(PYTHON) tools/rstlint.py -i tools -i venv

serve:
../Tools/scripts/serve.py build/html
Expand Down
21 changes: 11 additions & 10 deletions Doc/README.txt → Doc/README.rst
View file Edit file Delete file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,20 +2,21 @@ 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 <https://docs.python.org/dev/download.html>.

Documentation on authoring Python documentation, including information about
both style and markup, is available in the "Documenting Python" chapter of the
developers guide <https://docs.python.org/devguide/documenting.html>.


Building the docs
=================

You need to have Sphinx <http://sphinx-doc.org/> installed; it is the toolset
used to build the docs. It is not included in this tree, but maintained
separately and available from PyPI <https://pypi.python.org/pypi/Sphinx>.


Using make
Expand Down Expand Up @@ -108,11 +109,11 @@ see the make targets above).
Contributing
============

Bugs in the content should be reported to the Python bug tracker at
https://bugs.python.org.

Bugs in the toolset should be reported in the Sphinx bug tracker at
https://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.
Expand Down
2 changes: 1 addition & 1 deletion Doc/conf.py
View file Edit file Delete file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@
needs_sphinx = '1.2'

# Ignore any .rst files in the venv/ directory.
exclude_patterns = ['venv/*']


# Options for HTML output
Expand Down
30 changes: 21 additions & 9 deletions README.rst
View file Edit file Delete file
Open in desktop
Original file line number Diff line number Diff line change
@@ -15,6 +15,22 @@ reserved.

See the end of this file for further copyright and license information.


Using Python
------------
Expand All @@ -28,7 +44,7 @@ Installable Python kits, and information about using Python, are available at
Build Instructions
------------------

On Unix, Linux, BSD, OSX, and Cygwin::

./configure
make
Expand All @@ -38,10 +54,10 @@ On Unix, Linux, BSD, OSX, and Cygwin::
This will install Python as python3.

You can pass many options to the configure script; run ``./configure --help``
to find out more. On OSX and Cygwin, the executable is called ``python.exe``;
elsewhere it's just ``python``.

On Mac OS X, if you have configured Python with ``--enable-framework``, you
should use ``make frameworkinstall`` to do the installation. Note that this
installs the Python executable in a place that is not normally on your PATH,
you may want to set up a symlink in ``/usr/local/bin``.
Expand Up @@ -126,12 +142,8 @@ is downloadable in HTML, PDF, and reStructuredText formats; the latter version
is primarily for documentation authors, translators, and people with special
formatting requirements.

If you would like to contribute to the development of Python, relevant
documentation is available in the `Python Developer's Guide
<https://docs.python.org/devguide/>`_.

For information about building Python's documentation, refer to `Doc/README.txt
<https://github.com/python/cpython/blob/3.6/Doc/README.txt>`_.


Converting From Python 2.x to 3.x
Expand Down
Toggle all file notes Toggle all file annotations