python
Remove empty internals doc pages
Based on the discussion in the docs community meeting. I propose this, in short, I kept the only remaining content and moved it to an internals.rst file, removing the old "See the InternalDocs" pages.
📚 Documentation preview 📚: https://cpython-devguide--1712.org.readthedocs.build/internals/
Isn't this a bit of the restructuring?
@StanFromIreland, do you want to move “Source code layout” to CPython's InternalDocs? Then this part of devguide would only be a list of links. IMO, that would make the purpose and scope a lot clearer :)
The link to InternalDocs link should be first, not last.
Just a note, changes in the InternalDocs should be tied to changes in the DevGuide then. We can remove some sections from the InternalDocs, but DevGuide can still reference to those sections.
changes in the InternalDocs should be tied to changes in the DevGuide then
Yes. That's the case now, e.g. https://devguide.python.org/developer-workflow/grammar/
IMo we should keep these individual pages with links to InternalDocs, but add a link to the entire InternalDocs directory to each one, for the case that an individual document disappears. Also, we don't need to list these pages in the table of contents -- they're only there to keep the URL working.
Isn't this a bit of the restructuring?
That was my thinking too, we'll end up removing these pages at some point, why not do that now? "Baby steps" as some say.
move “Source code layout” to CPython's
InternalDocs
Sounds like a good idea, I'll open a PR.
The URLs will still work because they are now redirects in conf.py, no?
Yes, I don't want to leave dead links, so I made them redirect to the single page. We were referencing one of the empty pages in the CPython docs till a month or so ago, so I assume there are quite a few more in the wild.
I wrote https://github.com/python/cpython/pull/142237 to move it. I will update this PR when it is merged.
I think it's a shame to move things that are less inherently versioned (e.g. the general source tree layout) to InternalDocs/, as it's no longer on a website (we instead have to use GitHub's markdown rendering). Points taken on the restructuring, so I'll update my -1 to a -0 :).
A
I'm OK with moving this to GitHub rendering: the reason to learn about the layout of the code is so that you can read or modify some piece of code, so you will end up either in your local worktree or on GitHub eventually.
The last doc has been moved to InternalDocs/ in https://github.com/python/cpython/commit/a7501f07da98aadf5a29aa7a35da90409c59b212, the proposed internals.rst is now just a ~~list~~ table of links.