The PEPs in this repo are published automatically on the web at https://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.
See the Contributing Guidelines.
reStructuredText for PEPsOriginal PEP source should be written in reStructuredText format, which is a constrained version of plaintext, and is described in PEP 12. Older PEPs were often written in a more mildly restricted plaintext format, as described in PEP 9. 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. If you have pip, pip install docutils
should install it.
PEP 0 is automatically generated based on the metadata headers in other PEPs. The script handling this is genpepindex.py
, with supporting libraries in the pep0
directory.
Do not commit changes with bad formatting. To check the formatting of a PEP, use the Makefile. In particular, to generate HTML for PEP 9999, your source code should be in pep-9999.rst
and the HTML will be generated to pep-9999.html
by the command make pep-9999.html
. The default Make target generates HTML for all PEPs.
If you don't have Make, use the pep2html.py
script directly.
python.org includes its own helper modules to render PEPs as HTML, with suitable links back to the source pages in the version control repository.
These can be found at https://github.com/python/pythondotorg/tree/master/peps
When making changes to the PEP management process that may impact python.org's rendering pipeline:
PEP_REPO_PATH
in pydotorg/settings/local.py
to refer to your local clone of the PEP repository./manage.py generate_pep_pages
as described in https://pythondotorg.readthedocs.io/pep_generation.htmlThere is a Sphinx-rendered version of the PEPs at https://python.github.io/peps/ (updated on every push to master
)
Warning: This version is not, and should not be taken to be, a canonical source for PEPs whilst it remains in preview (please report any rendering bugs). The canonical source for PEPs remains https://www.python.org/dev/peps/
Build PEPs with Sphinx locally:make
, follow (i), otherwise (ii)
make sphinx-local
python build.py -j 8 --build-files
. Note that the jobs argument only takes effect on unix (non-mac) systems.build
directory of your PEPs repo to find the HTML pages. PEP 0 provides a formatted index, and may be a useful reference.Renderers:
-f
or --build-files
pep-XXXX.html
files
-d
or --build-dirs
index.html
files within pep-XXXX
directories
Options:
-i
or --index-file
-j
or --jobs
-n
or --nitpicky
-w
or --fail-on-warning
Tools:
-l
or --check-links
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4