Skip to content

Commit a79ec96

Browse files
Mariattaberkerpeksag
authored andcommitted
Improve documentation for generating PEP pages. (#1015)
1 parent 7db9d09 commit a79ec96

File tree

1 file changed

+13
-6
lines changed

1 file changed

+13
-6
lines changed

docs/source/pep_generation.rst

Lines changed: 13 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -11,11 +11,18 @@ We are generating the PEP pages by lightly parsing the HTML output from the
1111

1212
The PEP Page Generation process is as follows:
1313

14-
1. Set ``PEP_REPO_PATH`` in ``pydotorg/settings/local.py`` to the location
15-
of the `PEP Repository`_.
16-
2. Run ``pep2html.py``
17-
3. Run ``genpepindex.py``
18-
4. After all PEP pages are generated into HTML, run::
14+
1. Clone the PEP Repository, if you have not already done so::
15+
16+
$ git clone https://github.com/python/peps.git
17+
18+
2. From the cloned PEP Repository, run::
19+
20+
$ make -j
21+
22+
3. Set ``PEP_REPO_PATH`` in ``pydotorg/settings/local.py`` to the location
23+
of the cloned PEP Repository
24+
25+
4. Run in your ``pythondotorg`` repository::
1926

2027
$ ./manage.py generate_pep_pages
2128

@@ -45,4 +52,4 @@ dump_pep_pages
4552
This simply dumps our PEP related pages as JSON. The ``dumpdata`` content is
4653
written to ``stdout`` just like a normal ``dumpdata`` command.
4754

48-
.. _PEP Repository: https://hg.python.org/peps/
55+
.. _PEP Repository: https://github.com/python/peps.git

0 commit comments

Comments
 (0)