From a969b7e072201a0a6ecd30e1540e47d20529aa73 Mon Sep 17 00:00:00 2001 From: Georg Brandl Date: Wed, 29 Oct 2014 08:18:43 +0100 Subject: Doc readme: Fix markup, use https:// URLs. --- Doc/README.txt | 72 +++++++++++++++++++++++++++++----------------------------- 1 file changed, 36 insertions(+), 36 deletions(-) (limited to 'Doc/README.txt') diff --git a/Doc/README.txt b/Doc/README.txt index 952b320e54..1fc4a9f47a 100644 --- a/Doc/README.txt +++ b/Doc/README.txt @@ -7,7 +7,7 @@ available at . Documentation on authoring Python documentation, including information about both style and markup, is available in the "Documenting Python" chapter of the -developers guide . +developers guide . Building the docs @@ -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 @@ -43,53 +43,53 @@ the SPHINXBUILD variable. Available make targets are: - * "clean", which removes all build files. +* "clean", which removes all build files. - * "html", which builds standalone HTML files for offline viewing. +* "html", which builds standalone HTML files for offline viewing. - * "htmlview", which re-uses the "html" builder, but then opens the main page - in your default web browser. +* "htmlview", which re-uses the "html" builder, but then opens the main page + in your default web browser. - * "htmlhelp", which builds HTML files and a HTML Help project file usable to - convert them into a single Compiled HTML (.chm) file -- these are popular - under Microsoft Windows, but very handy on every platform. +* "htmlhelp", which builds HTML files and a HTML Help project file usable to + convert them into a single Compiled HTML (.chm) file -- these are popular + under Microsoft Windows, but very handy on every platform. - To create the CHM file, you need to run the Microsoft HTML Help Workshop - over the generated project (.hhp) file. The make.bat script does this for - you on Windows. + To create the CHM file, you need to run the Microsoft HTML Help Workshop + over the generated project (.hhp) file. The make.bat script does this for + you on Windows. - * "latex", which builds LaTeX source files as input to "pdflatex" to produce - PDF documents. +* "latex", which builds LaTeX source files as input to "pdflatex" to produce + PDF documents. - * "text", which builds a plain text file for each source file. +* "text", which builds a plain text file for each source file. - * "epub", which builds an EPUB document, suitable to be viewed on e-book - readers. +* "epub", which builds an EPUB document, suitable to be viewed on e-book + readers. - * "linkcheck", which checks all external references to see whether they are - broken, redirected or malformed, and outputs this information to stdout as - well as a plain-text (.txt) file. +* "linkcheck", which checks all external references to see whether they are + broken, redirected or malformed, and outputs this information to stdout as + well as a plain-text (.txt) file. - * "changes", which builds an overview over all versionadded/versionchanged/ - deprecated items in the current version. This is meant as a help for the - writer of the "What's New" document. +* "changes", which builds an overview over all versionadded/versionchanged/ + deprecated items in the current version. This is meant as a help for the + writer of the "What's New" document. - * "coverage", which builds a coverage overview for standard library modules and - C API. +* "coverage", which builds a coverage overview for standard library modules and + C API. - * "pydoc-topics", which builds a Python module containing a dictionary with - plain text documentation for the labels defined in - `tools/pyspecific.py` -- pydoc needs these to show topic and keyword help. +* "pydoc-topics", which builds a Python module containing a dictionary with + plain text documentation for the labels defined in + `tools/pyspecific.py` -- pydoc needs these to show topic and keyword help. - * "suspicious", which checks the parsed markup for text that looks like - malformed and thus unconverted reST. +* "suspicious", which checks the parsed markup for text that looks like + malformed and thus unconverted reST. - * "check", which checks for frequent markup errors. +* "check", which checks for frequent markup errors. - * "serve", which serves the build/html directory on port 8000. +* "serve", which serves the build/html directory on port 8000. - * "dist", (Unix only) which creates distributable archives of HTML, text, - PDF, and EPUB builds. +* "dist", (Unix only) which creates distributable archives of HTML, text, + PDF, and EPUB builds. Without make @@ -109,10 +109,10 @@ Contributing ============ Bugs in the content should be reported to the Python bug tracker at -http://bugs.python.org. +https://bugs.python.org. Bugs in the toolset should be reported in the Sphinx bug tracker at -http://www.bitbucket.org/birkenfeld/sphinx/issues/. +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. -- cgit v1.2.1