-
-
Notifications
You must be signed in to change notification settings - Fork 30.4k
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 and add formatting #104
Merged
Merged
Changes from 3 commits
Commits
Show all changes
7 commits
Select commit
Hold shift + click to select a range
1b2b0c1
Reformat Doc/README.txt to Doc/README.rst
66739e9
Update mention of Doc/README.rst
9faa6cf
Update mention of README.txt to README.rst
9f0c097
Make line fold
79e9aa8
rstlint ignore Doc/README.rst
e4abf45
conf.py ignore Doc/README.rst
bedc057
Update issue tracker url in Docs/README.rst
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -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 <https://docs.python.org/dev/download.html>. | ||
documentation. You don't need to build them yourself, `prebuilt versions are | ||
available <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>`_. | ||
|
||
|
||
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 <https://bugs.python.org>`_. | ||
|
||
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 <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. This link is outdated, it's now https://github.com/sphinx-doc/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. | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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.
folding long line is preferred.