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

[WIP] Move all PEPs into subdirectory #15

Closed
wants to merge 2 commits into from

Conversation

timofurrer
Copy link
Contributor

This change moves all PEPs into the peps/ subdirectory. The HTML files generated by pep2html.py will be located in output/.

The make command to convert a single PEP to HTML has changed slightly if you specify the path.
It's still the same when specifying the id.

From: make pep-0020.txt
To: make peps/pep-0020.txt

... just use tab completion ;)

Question: When you now open a converted HTML PEP locally in your browser you won't have any styles because the css files are still located in the project root directory and not in output. Do you think it makes sense to copy/link the css files to the output directory as well?

Please let me know if I've missed something to change or if this does not fit your needs yet.

Refs: #10

This change moves all PEPs into the `peps/`
subdirectory. The HTML files generated by
`pep2html.py` will be located in `output/`.

The `make` command to convert a single PEP to HTML
has changed slightly **if** you specify the path.
It's still same the when specifying the id.

From: `make pep-0020.txt`
To: `make peps/pep-0020.txt`

... just use tab completion ;)
@berkerpeksag
Copy link
Member

Nice clean-up, thanks! This is going to break python.org's PEP converter (should be easy to fix it but I'm not sure about the testing part).

@berkerpeksag berkerpeksag changed the title Move all PEPs into subdirectory [WIP] Move all PEPs into subdirectory Jun 18, 2016
@timofurrer
Copy link
Contributor Author

Okay, sorry about that. What/where can I find this python.org PEP converter? And where's the testing part?

Sent from my iPhone

On 17 Jun 2016, at 17:08, Berker Peksag notifications@github.com wrote:

Nice clean-up, thanks! This is going to break python.org's PEP converter (should be easy to fix it but I'm not sure about the testing part).


You are receiving this because you authored the thread.
Reply to this email directly, view it on GitHub, or mute the thread.

@berkerpeksag
Copy link
Member

The PEP converter lives in https://github.com/python/pythondotorg/tree/master/peps. The fake PEP repository we use for testing is in https://github.com/python/pythondotorg/tree/master/peps/tests/fake_pep_repo

@timofurrer
Copy link
Contributor Author

Okay, I'm going to work on that as good as I can and keep you posted.

@Carreau
Copy link
Contributor

Carreau commented Jun 18, 2016

As far as I understood from @brettcannon comment here, peps should moved to their own subdomain anyway.

@brettcannon
Copy link
Member

They should eventually, but there's no timeline on that so there's no need to design for it now.

@timofurrer
Copy link
Contributor Author

Yes, this change would not be necessary if you switch to sphinx now...

@timofurrer
Copy link
Contributor Author

I've already talked to @berkerpeksag about what he's written here earlier.

I've had a look at pythondotorg's PEP converter and it seems to me that if the PEP_REPO_PATH value from the django.settings would point to something like python/peps/output this should be fine. Unfortunately, I haven't seen yet how the PEPs are going to end up in this PEP_REPO_PATH location.

Maybe that's a no-brainer for someone here?

@dstufft
Copy link
Member

dstufft commented Jul 5, 2016

Just closing/reopening this so Travis will pick it up.

@dstufft dstufft closed this Jul 5, 2016
@dstufft dstufft reopened this Jul 5, 2016
@brettcannon
Copy link
Member

brettcannon commented Jul 19, 2016

Maybe we should close this PR since it's going to perpetually be in conflict while PEPs are being worked on?

@dstufft
Copy link
Member

dstufft commented Jul 19, 2016

Seems reasonable to me.

@brettcannon
Copy link
Member

Then I'm closing it. Thanks for the attempt, @timofurrer .

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

Successfully merging this pull request may close these issues.

6 participants