Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly
Appearance settings

Rename Doc/README.txt to Doc/README.rst #19

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

Closed
wants to merge 5 commits into from
Closed

Rename Doc/README.txt to Doc/README.rst #19

Changes from 1 commit
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
7eaa651
Update Doc README.txt to README.rst
Feb 11, 2017
6aa6dc3
Update file reference
Feb 11, 2017
bc35d3d
Update file reference
Feb 11, 2017
a88fcf1
Format URLs
Feb 13, 2017
08cb2a3
Further formatted text
Feb 13, 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
Prev Previous commit
Next Next commit
Format URLs
  • Loading branch information
Roger authored Feb 13, 2017
commit a88fcf14e8a3aea496e246e7967350a99d26b4f2
14 changes: 7 additions & 7 deletions 14 Doc/README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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>`_.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

..., [prebuilt versions are available].


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>`_.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

and [available from PyPI].



Using make
Expand Down Expand Up @@ -109,10 +109,10 @@ Contributing
============

Bugs in the content should be reported to the Python bug tracker at
Copy link
Member

Choose a reason for hiding this comment

The 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/>`_.
Copy link
Member

Choose a reason for hiding this comment

The 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.
Expand Down
Morty Proxy This is a proxified and sanitized view of the page, visit original site.