You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Indeed, since the main purpose is to be rendered on www.python.org I don't think this would change much. The added markup also isn't really used for PEPs.
So I envision this tying into #3 so that we can host things on Read the Docs and have a sub-domain for the PEPs.
So would that mean pepe would no longer be displayed on Python.org ?
Also from other project i'm contributing too, multiple domains for different section of a website are painful, (especially on readthedocs) because the navigation does not work well across site.
It would though most likely be feasible to build this on travis and cross-push on the python/pythondotorg repository to trigger a rebuild of the main website. Or of you don't like that, push a separate branch and auto submit a PR.
I don't care if the style changes. I just think having the PEPs buried in www.python.org and having such a separate build process is odd, especially when the contents have no direct connection to what's on www.python.org (who directly links to the PEPs from www.python.org anyway beyond navigation links?)
As for setting up some way to have pythondotorg automatically re-build the PEPs when a commit occurs, I'm quite happy to see that happen.
I don't care if the style changes. I just think having the PEPs buried in www.python.org and having such a separate build process is odd, especially when the contents have no direct connection to what's on www.python.org (who directly links to the PEPs from www.python.org anyway beyond navigation links?)
As for setting up some way to have pythondotorg automatically re-build the PEPs when a commit occurs, I'm quite happy to see that happen.
Thanks, that's a much simpler problem if we have less backward compatibility.
I'm combining #3 with this issue as there's no point in making the PEPs build with Sphinx if we don't create a subdomain of peps.python.org that is hosted on Read the Docs.
for fun i have created a PEP server that can be used to iterate on PEPs while seeing them in their final style.
it could be useful to get something close to the way PEPs look on python.org (since i already did the work to create a HTML template managing that does that):
it includes a server that serves HTML renders of PEPs without writing files. the pages contain live.js for auto-reloading and link the python.org stylesheet, so you can just edit away.
should i do a PR with it?
if yes, i’m interested in the scope for the provided scripts: are they all just for development? why the RSS stuff then?
The scripts in the project are actually used to generate the final files served at python.org/dev/peps.
As for a PR, feel free to propose it but I don't know what to think about it. I personally have never been bothered by the lack of styling when viewing generated PEPs (but then again I don't even bother with that anymore since we moved to GitHub when making edits to an existing PEP). If you want to discover this further, please open a new issue since this doesn't directly tie into using Sphinx for building.
Since GHP doesn't support Sphinx out of the box (only Jekyll for Markdown AFAIK), are you planning on using Actions to call out to Sphinx if you go that route?
We can definitely get 3.9 running on RTD. I will ping @astrojuanlu to look into this soon. We're also happy to remove ads for the PEPs repo, if that's an issue.
Another benefit of using RTD is that we're working on a number of additional features that will be useful for this. In particular, content embedding -- as well as generally having a more powerful search experience than vanilla Sphinx. The RTD team is also committed to helping work to make this a success, which is probably another Pro :)
Thanks Eric - I'm going to have a go on the testing image which supports 3.9, but part of me is pretty nervous deploying something explicitly labelled as testing!
@AA-Turner Ha, no worries on testing. It's basically just a way for us to provide it while we work on a better plan for upgrading our docker images. It should be as stable as any other build.
Thanks for the ping @ericholscher, I am now up to date with the whole conversation. Sent a small PR to save @AA-Turner some minutes of searching through our docs :) happy to help with anything else AA-Turner#3
Reacted by Adam Turner, Carol Willing, Hugo van Kemenade and Manuel Kaufmann
#2023 looks to add support for read the docs (or any other external documentation builder that supports Sphinx). Rendered preview at https://peps-aaturner.readthedocs.io/
A
Reacted by Hugo van Kemenade, Juan Luis Cano Rodríguez and Carol Willing
Activity
Carreau commentedon Jun 16, 2016
Does that have any impacts on https://www.python.org/dev/peps/* ?(which already renders the peps well)
birkenfeld commentedon Jun 16, 2016
Indeed, since the main purpose is to be rendered on www.python.org I don't think this would change much. The added markup also isn't really used for PEPs.
brettcannon commentedon Jun 16, 2016
So I envision this tying into #3 so that we can host things on Read the Docs and have a sub-domain for the PEPs.
birkenfeld commentedon Jun 16, 2016
Making that match the design and style currently used on python.org would be tedious, though.
Carreau commentedon Jun 16, 2016
So would that mean pepe would no longer be displayed on Python.org ?
Also from other project i'm contributing too, multiple domains for different section of a website are painful, (especially on readthedocs) because the navigation does not work well across site.
It would though most likely be feasible to build this on travis and cross-push on the python/pythondotorg repository to trigger a rebuild of the main website. Or of you don't like that, push a separate branch and auto submit a PR.
brettcannon commentedon Jun 16, 2016
I don't care if the style changes. I just think having the PEPs buried in www.python.org and having such a separate build process is odd, especially when the contents have no direct connection to what's on www.python.org (who directly links to the PEPs from www.python.org anyway beyond navigation links?)
As for setting up some way to have pythondotorg automatically re-build the PEPs when a commit occurs, I'm quite happy to see that happen.
Carreau commentedon Jun 17, 2016
Thanks, that's a much simpler problem if we have less backward compatibility.
[-]Make the peps build process use Sphinx[/-][+]Build PEPs using Sphinx, create peps.python.org[/+]brettcannon commentedon Jun 21, 2016
I'm combining #3 with this issue as there's no point in making the PEPs build with Sphinx if we don't create a subdomain of peps.python.org that is hosted on Read the Docs.
Merge pull request #2 from ilevkivskyi/master
foonsun commentedon Nov 30, 2016
thanks for your effort
[-]Build PEPs using Sphinx, create peps.python.org[/-][+]Build PEPs using Sphinx[/+]flying-sheep commentedon Dec 10, 2016
for fun i have created a PEP server that can be used to iterate on PEPs while seeing them in their final style.
it could be useful to get something close to the way PEPs look on python.org (since i already did the work to create a HTML template managing that does that):
https://gist.github.com/flying-sheep/c296482b785662d505f06c8bfe32f16e
it includes a server that serves HTML renders of PEPs without writing files. the pages contain live.js for auto-reloading and link the python.org stylesheet, so you can just edit away.
should i do a PR with it?
if yes, i’m interested in the scope for the provided scripts: are they all just for development? why the RSS stuff then?
brettcannon commentedon Dec 10, 2016
The scripts in the project are actually used to generate the final files served at python.org/dev/peps.
As for a PR, feel free to propose it but I don't know what to think about it. I personally have never been bothered by the lack of styling when viewing generated PEPs (but then again I don't even bother with that anymore since we moved to GitHub when making edits to an existing PEP). If you want to discover this further, please open a new issue since this doesn't directly tie into using Sphinx for building.
63 remaining items
warsaw commentedon Jun 29, 2021
See this ticket about Python 3.9.
Since GHP doesn't support Sphinx out of the box (only Jekyll for Markdown AFAIK), are you planning on using Actions to call out to Sphinx if you go that route?
AA-Turner commentedon Jun 29, 2021
The build script is already committed! https://github.com/python/peps/blob/master/.github/workflows/deploy-gh-pages.yaml
(GHA calls
makewhich callsbuild.pywhich orchastrates the process)A
AA-Turner commentedon Jun 29, 2021
Sounds good, thanks Carol!
ericholscher commentedon Jun 29, 2021
We can definitely get 3.9 running on RTD. I will ping @astrojuanlu to look into this soon. We're also happy to remove ads for the PEPs repo, if that's an issue.
Another benefit of using RTD is that we're working on a number of additional features that will be useful for this. In particular, content embedding -- as well as generally having a more powerful search experience than vanilla Sphinx. The RTD team is also committed to helping work to make this a success, which is probably another Pro :)
AA-Turner commentedon Jun 29, 2021
Thanks Eric - I'm going to have a go on the testing image which supports 3.9, but part of me is pretty nervous deploying something explicitly labelled as testing!
Will look through the rest in the morning
A
ericholscher commentedon Jun 29, 2021
@AA-Turner Ha, no worries on testing. It's basically just a way for us to provide it while we work on a better plan for upgrading our docker images. It should be as stable as any other build.
astrojuanlu commentedon Jun 30, 2021
Thanks for the ping @ericholscher, I am now up to date with the whole conversation. Sent a small PR to save @AA-Turner some minutes of searching through our docs :) happy to help with anything else AA-Turner#3
Sphinx support: theming (#1933)
willingc commentedon Jul 1, 2021
This is coming along nicely: https://python.github.io/peps/
Thanks to all for working on this 🍰
AA-Turner commentedon Jul 4, 2021
#2023 looks to add support for read the docs (or any other external documentation builder that supports Sphinx). Rendered preview at https://peps-aaturner.readthedocs.io/
A
astrojuanlu commentedon Dec 8, 2021
xref: conversation continues at https://discuss.python.org/t/request-for-comment-making-pep-rendering-self-contained/10774?u=astrojuanlu
AA-Turner commentedon Jan 10, 2022
small update: PEP 676 has been announced to python-dev at https://mail.python.org/archives/list/python-dev@python.org/thread/C675PLAF535FSUL7KX4FS2NK6ZPPQ3HB/
A
AA-Turner commentedon Mar 7, 2022
Update: PEP 676 has been accepted!
I'll leave this issue open until the implementation work is fully finished.
A