iSharkFly-Open
/
python-peps
mirror of https://github.com/python/peps.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Rename README and add a bit of formatting

This commit is contained in:
Georg Brandl 2016-06-16 06:36:43 +02:00
parent dd1e7667cc
commit 0dc36a211e
1 changed files with 9 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
README.txt → README.rst
View File

@ -4,8 +4,8 @@ Python Enhancement Proposals
The PEPs in this repo are published automatically on the web at
http://www.python.org/dev/peps/. To learn more about the purpose of
PEPs and how to go about writing a PEP, please start reading at PEP 1
(pep-0001.txt in this repo). Note that PEP 0, the index PEP, is now
automatically generated, and not committed to the repo.
(``pep-0001.txt`` in this repo). Note that PEP 0, the index PEP, is
now automatically generated, and not committed to the repo.
reStructuredText for PEPs
@ -14,13 +14,13 @@ reStructuredText for PEPs
Original PEP source may be written using two standard formats, a
mildly idiomatic plaintext format and the reStructuredText format
(also, technically plaintext). These two formats are described in
PEP 9 and PEP 12 respectively. The pep2html.py processing and
PEP 9 and PEP 12 respectively. The ``pep2html.py`` processing and
installation script knows how to produce the HTML for either PEP
format.
For processing reStructuredText format PEPs, you need the docutils
package, which is available from PyPI (http://pypi.python.org).
If you have pip, "pip install docutils" should install it.
package, which is available from `PyPI <http://pypi.python.org>`_.
If you have pip, ``pip install docutils`` should install it.
Generating HTML
@ -28,7 +28,7 @@ Generating HTML
Do not commit changes with bad formatting. To check the formatting of
a PEP, use the Makefile. In particular, to generate HTML for PEP 999,
your source code should be in pep-0999.txt and the HTML will be
generated to pep-0999.html by the command "make pep-0999.html". The
default Make target generates HTML for all PEPs. If you don't have
Make, use the pep2html.py script.
your source code should be in ``pep-0999.txt`` and the HTML will be
generated to ``pep-0999.html`` by the command ``make pep-0999.html``.
The default Make target generates HTML for all PEPs. If you don't have
Make, use the ``pep2html.py`` script.