Commit 69a72039 authored by Georg Brandl's avatar Georg Brandl

Doc readme: Fix markup, use https:// URLs.

parent 9ab33ead
...@@ -7,7 +7,7 @@ available at <https://docs.python.org/3.4/download.html>. ...@@ -7,7 +7,7 @@ available at <https://docs.python.org/3.4/download.html>.
Documentation on authoring Python documentation, including information about 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 <http://docs.python.org/devguide/documenting.html>. developers guide <https://docs.python.org/devguide/documenting.html>.
Building the docs Building the docs
...@@ -15,7 +15,7 @@ Building the docs ...@@ -15,7 +15,7 @@ Building the docs
You need to have Sphinx <http://sphinx-doc.org/> installed; it is the toolset 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 used to build the docs. It is not included in this tree, but maintained
separately and available from PyPI <http://pypi.python.org/pypi/Sphinx>. separately and available from PyPI <https://pypi.python.org/pypi/Sphinx>.
Using make Using make
...@@ -43,14 +43,14 @@ the SPHINXBUILD variable. ...@@ -43,14 +43,14 @@ the SPHINXBUILD variable.
Available make targets are: 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 * "htmlview", which re-uses the "html" builder, but then opens the main page
in your default web browser. in your default web browser.
* "htmlhelp", which builds HTML files and a HTML Help project file usable to * "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 convert them into a single Compiled HTML (.chm) file -- these are popular
under Microsoft Windows, but very handy on every platform. under Microsoft Windows, but very handy on every platform.
...@@ -58,37 +58,37 @@ Available make targets are: ...@@ -58,37 +58,37 @@ Available make targets are:
over the generated project (.hhp) file. The make.bat script does this for over the generated project (.hhp) file. The make.bat script does this for
you on Windows. you on Windows.
* "latex", which builds LaTeX source files as input to "pdflatex" to produce * "latex", which builds LaTeX source files as input to "pdflatex" to produce
PDF documents. 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 * "epub", which builds an EPUB document, suitable to be viewed on e-book
readers. readers.
* "linkcheck", which checks all external references to see whether they are * "linkcheck", which checks all external references to see whether they are
broken, redirected or malformed, and outputs this information to stdout as broken, redirected or malformed, and outputs this information to stdout as
well as a plain-text (.txt) file. well as a plain-text (.txt) file.
* "changes", which builds an overview over all versionadded/versionchanged/ * "changes", which builds an overview over all versionadded/versionchanged/
deprecated items in the current version. This is meant as a help for the deprecated items in the current version. This is meant as a help for the
writer of the "What's New" document. writer of the "What's New" document.
* "coverage", which builds a coverage overview for standard library modules and * "coverage", which builds a coverage overview for standard library modules and
C API. C API.
* "pydoc-topics", which builds a Python module containing a dictionary with * "pydoc-topics", which builds a Python module containing a dictionary with
plain text documentation for the labels defined in plain text documentation for the labels defined in
`tools/pyspecific.py` -- pydoc needs these to show topic and keyword help. `tools/pyspecific.py` -- pydoc needs these to show topic and keyword help.
* "suspicious", which checks the parsed markup for text that looks like * "suspicious", which checks the parsed markup for text that looks like
malformed and thus unconverted reST. 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, * "dist", (Unix only) which creates distributable archives of HTML, text,
PDF, and EPUB builds. PDF, and EPUB builds.
...@@ -109,10 +109,10 @@ Contributing ...@@ -109,10 +109,10 @@ Contributing
============ ============
Bugs in the content should be reported to the Python bug tracker at 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 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, 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. and we will process your request as soon as possible.
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment