-
-
Notifications
You must be signed in to change notification settings - Fork 942
Remove empty internals doc pages #1712
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
base: main
Are you sure you want to change the base?
Conversation
# Conflicts: # internals/compiler.rst # internals/garbage-collector.rst # internals/interpreter.rst # internals/parser.rst
AA-Turner
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Unsure if we should churn this if we're going to restructure anyway?
|
Isn't this a bit of the restructuring? @StanFromIreland, do you want to move “Source code layout” to CPython's |
|
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. |
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. |
|
The URLs will still work because they are now redirects in conf.py, no? |
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.
Sounds like a good idea, I'll open a PR.
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 python/cpython#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 A |
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.rstfile, removing the old "See the InternalDocs" pages.📚 Documentation preview 📚: https://cpython-devguide--1712.org.readthedocs.build/