From 1b2b0c11290c75adf56a5800100c1f5ff2bfae81 Mon Sep 17 00:00:00 2001 From: Roger Date: Tue, 14 Feb 2017 20:03:39 -0500 Subject: [PATCH 1/7] Reformat Doc/README.txt to Doc/README.rst --- Doc/{README.txt => README.rst} | 20 ++++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) rename Doc/{README.txt => README.rst} (83%) diff --git a/Doc/README.txt b/Doc/README.rst similarity index 83% rename from Doc/README.txt rename to Doc/README.rst index 4f8e9f8f1417fb..a830ac80f4df5a 100644 --- a/Doc/README.txt +++ b/Doc/README.rst @@ -2,20 +2,20 @@ 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 . +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 -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 @@ -108,11 +108,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 content should be reported to the +`Python bug tracker `_. -Bugs in the toolset should be reported in the Sphinx bug tracker at -https://www.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. From 66739e9e8a62781174c8e7702ed6b94e5a15ee4f Mon Sep 17 00:00:00 2001 From: Roger Date: Tue, 14 Feb 2017 20:05:09 -0500 Subject: [PATCH 2/7] Update mention of Doc/README.rst --- README.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.rst b/README.rst index c6cca80b41273a..652dfef7df304a 100644 --- a/README.rst +++ b/README.rst @@ -130,8 +130,8 @@ If you would like to contribute to the development of Python, relevant documentation is available in the `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 9faa6cf639ccba9b9a0481f57178c031cd402199 Mon Sep 17 00:00:00 2001 From: Roger Date: Tue, 14 Feb 2017 20:05:57 -0500 Subject: [PATCH 3/7] Update mention of README.txt to README.rst --- Doc/make.bat | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Doc/make.bat b/Doc/make.bat index d0b59618261011..b1a3738f309d3b 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 9f0c0973c4bc3d68cfb51423d8bb9909b2558d05 Mon Sep 17 00:00:00 2001 From: Roger Date: Tue, 14 Feb 2017 23:07:33 -0500 Subject: [PATCH 4/7] Make line fold --- Doc/README.rst | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/Doc/README.rst b/Doc/README.rst index a830ac80f4df5a..9bf7172f64c614 100644 --- a/Doc/README.rst +++ b/Doc/README.rst @@ -6,7 +6,8 @@ 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 +both style and markup, is available in the "`Documenting Python +`_" chapter of the developers guide. From 79e9aa8ff24635bd45fad5f515447636d3e9e483 Mon Sep 17 00:00:00 2001 From: Roger Date: Wed, 15 Feb 2017 16:13:50 -0500 Subject: [PATCH 5/7] rstlint ignore Doc/README.rst --- Doc/Makefile | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Doc/Makefile b/Doc/Makefile index 6e1c18304080d6..c5301c819b40f7 100644 --- a/Doc/Makefile +++ b/Doc/Makefile @@ -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 + $(PYTHON) tools/rstlint.py -i tools -i venv -i README.rst serve: ../Tools/scripts/serve.py build/html From e4abf45cb1e731a5c552fecd8310293799d18154 Mon Sep 17 00:00:00 2001 From: Roger Date: Wed, 15 Feb 2017 16:14:54 -0500 Subject: [PATCH 6/7] conf.py ignore Doc/README.rst --- Doc/conf.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Doc/conf.py b/Doc/conf.py index b3f26d5a692163..18aebb68a8d8df 100644 --- a/Doc/conf.py +++ b/Doc/conf.py @@ -37,7 +37,7 @@ needs_sphinx = '1.2' # Ignore any .rst files in the venv/ directory. -exclude_patterns = ['venv/*'] +exclude_patterns = ['venv/*', 'README.rst'] # Options for HTML output From bedc05789d5ea2849ca5a10146b37042b8e4a15e Mon Sep 17 00:00:00 2001 From: Roger Date: Wed, 15 Feb 2017 17:26:15 -0500 Subject: [PATCH 7/7] Update issue tracker url in Docs/README.rst --- Doc/README.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Doc/README.rst b/Doc/README.rst index 9bf7172f64c614..dcd3d6e80ff3c4 100644 --- a/Doc/README.rst +++ b/Doc/README.rst @@ -113,7 +113,7 @@ Bugs in the content should be reported to the `Python bug tracker `_. Bugs in the toolset should be reported in the -`Sphinx bug tracker `_. +`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.