Skip to content

Commit 03c7456

Browse files
authored
Meta: Move documentation to to peps/ folder (#4538)
1 parent 43fa042 commit 03c7456

File tree

5 files changed

+17
-2
lines changed

5 files changed

+17
-2
lines changed

README.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ You can find it in the merge box at the bottom of the PR page:
4949
Render PEPs locally
5050
-------------------
5151

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

peps/contents.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@ This is an internal Sphinx page; please go to the :doc:`PEP Index <pep-0000>`.
1515
:caption: PEP Table of Contents (needed for Sphinx):
1616

1717
api/*
18+
docs/*
1819
topic/*
1920
numerical
2021
pep-*
File renamed without changes.

peps/docs/index.rst

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
..
2+
We can't use :pep:`N` references in this document, as they use links relative
3+
to the current file, which doesn't work in a subdirectory like this one.
4+
5+
PEPs Internal Documentation
6+
===========================
7+
8+
This is documentation for the internals of the PEPs website and PEP rendering
9+
system. To read the PEPs, see the :doc:`PEP Index <../pep-0000>`.
10+
11+
------------------------------------------------------------------------------
12+
13+
* :doc:`Building PEPs Locally <./build>`
14+
* :doc:`An Overview of the PEP Rendering System <./rendering_system>`

docs/rendering_system.rst renamed to peps/docs/rendering_system.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ The configuration:
3535
----------------
3636

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

4040

4141
3. Extension

0 commit comments

Comments
 (0)