8000 Reformat Doc/README.txt to Doc/README.rst · python/cpython@1b2b0c1 · GitHub
[go: up one dir, main page]

Skip to content

Commit 1b2b0c1

Browse files
author
Roger
authored
Reformat Doc/README.txt to Doc/README.rst
1 parent b52260d commit 1b2b0c1

File tree

1 file changed

+10
-10
lines changed

1 file changed

+10
-10
lines changed

Doc/README.txt renamed to Doc/README.rst

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -2,20 +2,20 @@ Python Documentation README
22
~~~~~~~~~~~~~~~~~~~~~~~~~~~
33

44
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/dev/download.html>.
5+
documentation. You don't need to build them yourself, `prebuilt versions are
6+
available <https://docs.python.org/dev/download.html>`_.
77

88
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>.
9+
both style and markup, is available in the "`Documenting Python <https://docs.python.org/devguide/documenting.html>`_" chapter of the
10+
developers guide.
1111

1212

1313
Building the docs
1414
=================
1515

16-
You need to have Sphinx <http://sphinx-doc.org/> installed; it is the toolset
16+
You need to have `Sphinx <http://sphinx-doc.org/>`_ installed; it is the toolset
1717
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>.
18+
separately and `available from PyPI <https://pypi.python.org/pypi/Sphinx>`_.
1919

2020

2121
Using make
@@ -108,11 +108,11 @@ see the make targets above).
108108
Contributing
109109
============
110110

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

114-
Bugs in the toolset should be reported in the Sphinx bug tracker at
115-
https://www.bitbucket.org/birkenfeld/sphinx/issues/.
114+
Bugs in the toolset should be reported in the
115+
`Sphinx bug tracker <https://www.bitbucket.org/birkenfeld/sphinx/issues/>`_.
116116

117117
You can also send a mail to the Python Documentation Team at docs@python.org,
118118
and we will process your request as soon as possible.

0 commit comments

Comments
 (0)
0