Visitar URL original
Rename Doc/README.txt to Doc/README.rst and add formatting · Pull Request #104 · python/cpython · GitHub
Skip to content

Rename Doc/README.txt to Doc/README.rst and add formatting #104

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.

Sign up for GitHub

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

Merged
vstinner merged 7 commits into from Feb 15, 2017
Merged

Rename Doc/README.txt to Doc/README.rst and add formatting #104

Changes from 1 commit
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
1b2b0c1
Reformat Doc/README.txt to Doc/README.rst
Feb 15, 2017
66739e9
Update mention of Doc/README.rst
Feb 15, 2017
9faa6cf
Update mention of README.txt to README.rst
Feb 15, 2017
9f0c097
Make line fold
Feb 15, 2017
79e9aa8
rstlint ignore Doc/README.rst
Feb 15, 2017
e4abf45
conf.py ignore Doc/README.rst
Feb 15, 2017
bedc057
Update issue tracker url in Docs/README.rst
Feb 15, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Next Next commit
Reformat Doc/README.txt to Doc/README.rst
  • Loading branch information
Roger
Roger authored Feb 15, 2017
commit 1b2b0c11290c75adf56a5800100c1f5ff2bfae81
20 changes: 10 additions & 10 deletions Doc/README.txt → Doc/README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.

@methane methane Feb 15, 2017

Copy link
Copy Markdown
Member

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.



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
Expand Down Expand Up @@ -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/>`_.

@vstinner vstinner Feb 15, 2017

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The 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.
Expand Down