Skip to content

Meta: Move documentation to to peps/ folder #4538

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
merged 1 commit into from
Aug 8, 2025
Merged

Meta: Move documentation to to peps/ folder #4538

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 1 addition & 1 deletion README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ You can find it in the merge box at the bottom of the PR page:
Render PEPs locally
-------------------

See the `build documentation <./docs/build.rst>`__ for full
See the `build documentation <./peps/docs/build.rst>`__ for full
instructions on how to render PEPs locally.
In summary, run the following in a fresh, activated virtual environment:

Expand Down
1 change: 1 addition & 0 deletions peps/contents.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ This is an internal Sphinx page; please go to the :doc:`PEP Index <pep-0000>`.
:caption: PEP Table of Contents (needed for Sphinx):

api/*
docs/*
topic/*
numerical
pep-*
0 docs/build.rst → peps/docs/build.rst
View file
Open in desktop
File renamed without changes.
14 changes: 14 additions & 0 deletions peps/docs/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
..
We can't use :pep:`N` references in this document, as they use links relative
to the current file, which doesn't work in a subdirectory like this one.

PEPs Internal Documentation
===========================

This is documentation for the internals of the PEPs website and PEP rendering
system. To read the PEPs, see the :doc:`PEP Index <../pep-0000>`.

------------------------------------------------------------------------------

* :doc:`Building PEPs Locally <./build>`
* :doc:`An Overview of the PEP Rendering System <./rendering_system>`
2 changes: 1 addition & 1 deletion docs/rendering_system.rst → peps/docs/rendering_system.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ The configuration:
----------------

``build.py`` manages the rendering process.
Usage is covered in `Building PEPs Locally <./build.rst>`_.
Usage is covered in :doc:`Building PEPs Locally <./build>`.


3. Extension
Expand Down