Skip to content
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.

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

Convert PEP index to ReST #705

Merged
merged 3 commits into from Jul 10, 2018
Merged

Convert PEP index to ReST #705

merged 3 commits into from Jul 10, 2018

Conversation

@ncoghlan
Copy link
Contributor

@ncoghlan ncoghlan commented Jul 8, 2018

Converting the PEP index to reStructuredText allows for
direct hyperlinks to individual PEP categories, as well as
other parts of the PEP index.
It also provides a hyperlinked Table of Contents at the top
of the page for easier navigation.

@ncoghlan
Copy link
Contributor Author

@ncoghlan ncoghlan commented Jul 8, 2018

This appears to be working for local rendering, but I've marked it as WIP since I haven't even tried rendering it locally with the python.org renderer, and it seems like a bad idea to mess with the main PEP index without testing that first :)

@pradyunsg
Copy link
Contributor

@pradyunsg pradyunsg commented Jul 8, 2018

#463?

@ncoghlan
Copy link
Contributor Author

@ncoghlan ncoghlan commented Jul 8, 2018

Ah, d'oh - I was only looking at the issue list, not the open PR list :P

(I had seen the other PR before - I just thought I was misremembering when I didn't see it in the issue list)

@ncoghlan
Copy link
Contributor Author

@ncoghlan ncoghlan commented Jul 8, 2018

Closing in favour of #463

@ncoghlan ncoghlan closed this Jul 8, 2018
@mozillazg mozillazg mentioned this pull request Jul 8, 2018
5 of 5 tasks complete
@gvanrossum
Copy link
Member

@gvanrossum gvanrossum commented Jul 8, 2018

People like this one better.

@gvanrossum gvanrossum reopened this Jul 8, 2018
ncoghlan added 2 commits Jul 9, 2018
@ncoghlan ncoghlan changed the title WIP: Convert PEP index to ReST Convert PEP index to ReST Jul 9, 2018
@ncoghlan
Copy link
Contributor Author

@ncoghlan ncoghlan commented Jul 9, 2018

This is 3.5 compatible now, but I'm not going to risk breaking the PEP index right before I go to bed :)

If someone else wants to merge it, feel free to do so, otherwise I'll handle it tomorrow night.

@ncoghlan ncoghlan merged commit d18a264 into python:master Jul 10, 2018
1 check passed
1 check passed
continuous-integration/travis-ci/pr The Travis CI build passed
Details
ncoghlan added a commit to ncoghlan/peps that referenced this pull request Jul 10, 2018
Quick fix to resolve PEP 0 live rendering issues.

This reverts commit d18a264.
@ncoghlan
Copy link
Contributor Author

@ncoghlan ncoghlan commented Jul 10, 2018

I created #722 so I have a quick button to push if the live rendering turns out to have unanticipated problems.

@ncoghlan
Copy link
Contributor Author

@ncoghlan ncoghlan commented Jul 10, 2018

It's been over an hour (which is usually long enough for the Fastly cache to expire), and https://www.python.org/dev/peps/ still hasn't updated for me. @berkerpeksag, would you be able to investigate whether or not the site's actually managing to build the PEPs repo now?

If it is broken, then it will likely make sense to edit the title and commit message, then hit the merge button on #722, so updates to other PEPs can still go through.

@berkerpeksag
Copy link
Member

@berkerpeksag berkerpeksag commented Jul 10, 2018

I've just ran the following commands:

$ make -C /srv/pydotorg/peps update all rss
make: Entering directory `/srv/pydotorg/peps'
git pull https://github.com/python/peps.git
From https://github.com/python/peps
 * branch            HEAD       -> FETCH_HEAD
Already up-to-date.
make: Circular pep-0000.rst <- pep-0000.rst dependency dropped.
make: Nothing to be done for `all'.
python3 pep2rss.py .
make: Leaving directory `/srv/pydotorg/peps'

and

$ /srv/pydotorg/env/bin/python /srv/pydotorg/pythondotorg/manage.py generate_pep_pages --settings pydotorg.settings.server

Both commands worked fine:

screenshot from 2018-07-10 18 09 18

I've also purged the cache for https://www.python.org/dev/peps/

I've also confirmed that the peps checkout is up-to-date:

pydotorg@pydotorg-prod:/srv/pydotorg/peps$ git log -1
commit abab110be10b0895ec4f3b210220096fa129e6f7
Author: Harmon <Harmon758@gmail.com>
Date:   Tue Jul 10 09:05:08 2018 -0500

    Fix pep2rss to specify output encoding (GH-634)
@berkerpeksag
Copy link
Member

@berkerpeksag berkerpeksag commented Jul 10, 2018

Ok, I've rebuilt PEP index, ran generate_pep_pages, and purged Fastly cache. It works now: https://www.python.org/dev/peps/

Thanks!

@ncoghlan
Copy link
Contributor Author

@ncoghlan ncoghlan commented Jul 10, 2018

Thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Linked issues

Successfully merging this pull request may close these issues.

None yet

5 participants