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

gh-119786: Move parser doc from devguide to InternalDocs #1431

Merged
merged 1 commit into from
Oct 9, 2024

Conversation

iritkatriel
Copy link
Member

@iritkatriel iritkatriel commented Oct 8, 2024

Copy link
Member

@ezio-melotti ezio-melotti left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I wonder if we can use rediraffe or something similar to (eventually) get rid of this page altogether and redirect to the CPython repo directly.

@JacobCoffee
Copy link
Member

JacobCoffee commented Oct 9, 2024

@ezio-melotti what if we just updated the link altogether in https://github.com/iritkatriel/devguide/blob/remove_parser_doc/internals/index.rst then we could remove the file. Not sure if our theme automatically adds the external link notification/icon, though

Example

https://github.com/litestar-org/litestar/blob/47c09ffce8e8c25a865a6703097709403a22f335/docs/index.rst#L363

image
===================
CPython's internals
===================

This guide describes the basics of CPython's internals.
It explains the layout of CPython's source code.
It also explains how the parser, compiler, and interpreter
work together to run your Python code.
Finally, it covers the garbage collector and how it manages memory.

.. toctree::
   :maxdepth: 3

   exploring
   parser <https://github.com/python/cpython/blob/main/InternalDocs/parser.md>
   compiler
   interpreter
   garbage-collector

@ezio-melotti
Copy link
Member

There might be external websites linking to this page, and removing it altogether will result in a 404. This is also why we adopted Rediraffe after we reorganized the devguide to group similar pages in different sections.

OTOH it feels a bit weird to have a redirect that goes outside the devguide, so leaving an almost-empty page is probably ok unless someone has a better idea.

@iritkatriel iritkatriel removed the status-do not merge Do not merge the PR label Oct 9, 2024
@iritkatriel iritkatriel merged commit f4524c4 into python:main Oct 9, 2024
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants