From 7eaa651f2a6966e7f280f444035d8323d60a5fb1 Mon Sep 17 00:00:00 2001 From: Roger Date: Fri, 10 Feb 2017 22:36:20 -0500 Subject: [PATCH 1/5] Update Doc README.txt to README.rst --- Doc/{README.txt => README.rst} | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename Doc/{README.txt => README.rst} (100%) diff --git a/Doc/README.txt b/Doc/README.rst similarity index 100% rename from Doc/README.txt rename to Doc/README.rst From 6aa6dc3d85481ebfe4ec135efded9c47a9ae6e2c Mon Sep 17 00:00:00 2001 From: Roger Date: Fri, 10 Feb 2017 22:37:14 -0500 Subject: [PATCH 2/5] Update file reference --- README.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.rst b/README.rst index a34373f3518eac..093bd8128043f2 100644 --- a/README.rst +++ b/README.rst @@ -115,7 +115,7 @@ If you would like to contribute to the development of Python, relevant documentation is available at: `Python Developer's Guide `_. -For information about building Python's documentation, refer to Doc/README.txt. +For information about building Python's documentation, refer to Doc/README.rst. Converting From Python 2.x to 3.x From bc35d3d6ef190a1421ec6b3453eac61f1c57f826 Mon Sep 17 00:00:00 2001 From: Roger Date: Fri, 10 Feb 2017 22:37:42 -0500 Subject: [PATCH 3/5] Update file reference --- Doc/make.bat | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Doc/make.bat b/Doc/make.bat index da1f8765a4f358..3302ec1099112b 100644 --- a/Doc/make.bat +++ b/Doc/make.bat @@ -74,7 +74,7 @@ echo. Provided by this script: echo. clean, check, serve, htmlview echo. echo.All arguments past the first one are passed through to sphinx-build as -echo.filenames to build or are ignored. See README.txt in this directory or +echo.filenames to build or are ignored. See README.rst in this directory or echo.the documentation for your version of Sphinx for more exhaustive lists echo.of available targets and descriptions of each. echo. From a88fcf14e8a3aea496e246e7967350a99d26b4f2 Mon Sep 17 00:00:00 2001 From: Roger Date: Sun, 12 Feb 2017 19:11:05 -0500 Subject: [PATCH 4/5] Format URLs --- Doc/README.rst | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/Doc/README.rst b/Doc/README.rst index 4f8e9f8f1417fb..18d8f169d7892a 100644 --- a/Doc/README.rst +++ b/Doc/README.rst @@ -3,19 +3,19 @@ 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 . +available at `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 . +both style and markup, is available in the "`Documenting Python `_" chapter of the +developers guide. Building the docs ================= -You need to have Sphinx installed; it is the toolset +You need to have `Sphinx `_ installed; it is the toolset used to build the docs. It is not included in this tree, but maintained -separately and available from PyPI . +separately and available from `PyPI `_. Using make @@ -109,10 +109,10 @@ Contributing ============ Bugs in the content should be reported to the Python bug tracker at -https://bugs.python.org. +`bugs.python.org `_. Bugs in the toolset should be reported in the Sphinx bug tracker at -https://www.bitbucket.org/birkenfeld/sphinx/issues/. +`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. From 08cb2a3cdcad7d7e5e9fc239511ff4d6d415b5e4 Mon Sep 17 00:00:00 2001 From: Roger Date: Sun, 12 Feb 2017 19:27:43 -0500 Subject: [PATCH 5/5] Further formatted text --- Doc/README.rst | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/Doc/README.rst b/Doc/README.rst index 18d8f169d7892a..a830ac80f4df5a 100644 --- a/Doc/README.rst +++ b/Doc/README.rst @@ -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 `_. +documentation. You don't need to build them yourself, `prebuilt versions are +available `_. Documentation on authoring Python documentation, including information about both style and markup, is available in the "`Documenting Python `_" chapter of the @@ -15,7 +15,7 @@ Building the docs You need to have `Sphinx `_ installed; it is the toolset used to build the docs. It is not included in this tree, but maintained -separately and available from `PyPI `_. +separately and `available from PyPI `_. Using make @@ -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 `_. +Bugs in the content should be reported to the +`Python bug tracker `_. -Bugs in the toolset should be reported in the Sphinx bug tracker at -`bitbucket.org/birkenfeld/sphinx/issues/ `_. +Bugs in the toolset should be reported in the +`Sphinx bug tracker `_. 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.