-
-
Notifications
You must be signed in to change notification settings - Fork 30.9k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Rename Doc/README.txt to Doc/README.rst #19
Changes from 4 commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -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 <https://docs.python.org/dev/download.html>. | ||
available at `docs.python.org/dev/download.html <https://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 <https://docs.python.org/devguide/documenting.html>. | ||
both style and markup, is available in the "`Documenting Python <https://docs.python.org/devguide/documenting.html>`_" chapter of the | ||
developers guide. | ||
|
||
|
||
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 | ||
separately and available from PyPI <https://pypi.python.org/pypi/Sphinx>. | ||
separately and available from `PyPI <https://pypi.python.org/pypi/Sphinx>`_. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. and [available from PyPI]. |
||
|
||
|
||
Using make | ||
|
@@ -109,10 +109,10 @@ Contributing | |
============ | ||
|
||
Bugs in the content should be reported to the Python bug tracker at | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. "Bugs in the content should be reported to the [Python bug tracker]." |
||
https://bugs.python.org. | ||
`bugs.python.org <https://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/ <https://www.bitbucket.org/birkenfeld/sphinx/issues/>`_. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I suggest "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. | ||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -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 | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This PR renames Doc/README.txt to Doc/README.rst. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Ah, I'm sorry. I misundersttod. |
||
echo.the documentation for your version of Sphinx for more exhaustive lists | ||
echo.of available targets and descriptions of each. | ||
echo. | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
..., [prebuilt versions are available].