8000 Rename Doc/README.txt to Doc/README.rst · Pull Request #19 · python/cpython · GitHub
[go: up one dir, main page]
Skip to content

Rename Doc/README.txt to Doc/README.rst #19

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 5 commits into from
Closed

Rename Doc/README.txt to Doc/README.rst #19

Changes from 1 commit
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
7eaa651
Update Doc README.txt to README.rst
Feb 11, 2017
6aa6dc3
Update file reference
Feb 11, 2017
bc35d3d
Update file reference
Feb 11, 2017
a88fcf1
Format URLs
Feb 13, 2017
08cb2a3
Further formatted text
Feb 13, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Further formatted text
  • Loading branch information
Roger authored Feb 13, 2017
commit 08cb2a3cdcad7d7e5e9fc239511ff4d6d415b5e4
14 changes: 7 additions & 7 deletions Doc/README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@ 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 `docs.python.org/dev/download.html <https://docs.python.org/dev/download.html>`_.
documentation. You don't need to build them yourself, `prebuilt versions are
available <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 <https://docs.python.org/devguide/documenting.html>`_" chapter of the
Expand All @@ -15,7 +15,7 @@ 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>`_.
separately and `available from PyPI <https://pypi.python.org/pypi/Sphinx>`_.


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

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

Bugs in the toolset should be reported in the Sphinx bug tracker at
`bitbucket.org/birkenfeld/sphinx/issues/ <https://www.bitbucket.org/birkenfeld/sphinx/issues/>`_.
Bugs in the toolset should be reported in the
`Sphinx bug tracker <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
0