@@ -6,39 +6,43 @@ PEP Page Generation
6
6
Process Overview
7
7
----------------
8
8
9
- We are generating the PEP pages by lightly parsing and cleaning up the HTML output from the `PEP Mercurial Repository <http://hg.python.org/peps/ >`_.
9
+ We are generating the PEP pages by lightly parsing the HTML output from the
10
+ `PEP Repository `_ and then cleaning up some post-parsing formatting.
10
11
11
- The process is as follows:
12
+ ThePEP Page Generation process is as follows:
12
13
13
- 1. Clone and/or update the PEP repo located in `settings.PEP_REPO_PATH ` to the latest revision.
14
- 2. Run `pep2html.py `
15
- 3. Run `genpepindex.py `
16
- 4. Once all PEP HTML pages are generated, run `./manage.py generate_pep_pages `
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::
17
19
18
- .. note :: Steps 2 and 3 currently must be run using Python 2 and **NOT** Python 3 like the rest of Python.org
20
+ $ ./manage.py generate_pep_pages
19
21
20
- This processwill be run periodically via cron to keep the PEP pages up to date.
22
+ This processruns periodically via cron to keep the PEP pages up to date.
21
23
22
24
Management Commands
23
25
-------------------
24
26
25
27
generate_pep_pages
26
28
^^^^^^^^^^^^^^^^^^
27
29
28
- This Django management command generates `pages.Page ` objectsbased on the output of the existing PEP repository
29
- generation process. You run it like::
30
+ This Django management command generates `` pages.Page `` objectsfrom the output
31
+ of the existing PEP repository generation process. You run it like::
30
32
31
- ./manage.py generate_pep_pages
33
+ $ ./manage.py generate_pep_pages
32
34
33
35
To get verbose output run it like::
34
36
35
- ./manage.py generate_pep_pages --verbosity=2
37
+ $ ./manage.py generate_pep_pages --verbosity=2
36
38
37
- It uses the conversion code in the `peps.converters ` module in an attempt to normalize the formatting for display
38
- purposes.
39
+ It uses the conversion code in the `` peps.converters `` module in an attempt to
40
+ normalize the formatting for display purposes.
39
41
40
42
dump_pep_pages
41
43
^^^^^^^^^^^^^^
42
44
43
- This simply dumps our PEP related pages as JSON like dumpdata would do with a --pks options if the site was using
44
- Django 1.6 or newer. The dumpdata content is written to stdout just like a normal dumpdata command.
45
+ This simply dumps our PEP related pages as JSON. The ``dumpdata `` content is
46
+ written to ``stdout `` just like a normal ``dumpdata `` command.
47
+
48
+ .. _PEP Repository :https://hg.python.org/peps/