Conversation
| [Adam]: I did go through and get a list of issues re: how our model differs from RtD | ||
| expectations, I might have another go at figuring out how to reconcile the approaches. | ||
|
|
||
| [Carol]: We need to involve the relevant people - Manuel, Adam, Petr, release managers, |
There was a problem hiding this comment.
Hi 👋🏼 , I'm Manuel from Read the Docs and I just saw this comment here. I wasn't being able to participate in the meetings lately, but I've been reading all these notes. So, here I am 😄
We made some progress some time ago with Hugo, Carol and other folks. Currently there is a CPython project that builds the previews every time a push is done:
- Project: https://app.readthedocs.org/projects/cpython-previews/
- Documentation: https://cpython-previews.readthedocs.io/en/main/
It makes usage of the Read the Docs Addons API through this file https://github.com/python/cpython/blob/f0799795994bfd9ab0740c4d70ac54270991ba47/Doc/tools/static/rtd_switcher.js to generate the version and language selectors.
Besides, we did some tests with the Spanish translation as well:
- Project: https://app.readthedocs.org/projects/cpython-previews-es/
- Documentation: https://cpython-previews.readthedocs.io/es/latest/
We've also enabled some cool features like "Visual Diff" that shows the differences between the PR and the default version of the docs and lists of all the files that were changed. Here you have a small example https://cpython-previews--134377.org.readthedocs.build/en/134377/library/dataclasses.html?readthedocs-diff=true&readthedocs-diff-chunk=4
All these conversations happened in Discord under the #infra channel inside a thread named RTD for the Python docs. Feel free to ping me here or there if you want to continue this conversation in case of clarification of any doubts or coordination ❤️
3 participants
📚 Documentation preview 📚: https://docs-community--158.org.readthedocs.build/