devguide icon indicating copy to clipboard operation
devguide copied to clipboard

Slim down or remove remaining internals docs

Open willingc opened this issue 1 year ago • 1 comments

https://github.com/python/cpython/issues/119786 moved a number of internals docs to the cpython repo. This makes good sense. We should slim down the devguide's internals section, and refer to the CPython versioned internals docs.

willingc avatar Jul 08 '24 09:07 willingc

I had noticed a few related PRs and tracked down the issue you linked, but I didn't find where this was discussed/decided. While I understand the need to have a versioned doc, I wonder if (and which) other solutions have been considered, and whether the InternalDocs dir is a temporary solution or a definitive one. In particular, are there plans to publish the internal docs somewhere other than GitHub itself[^1]? Was using rst considered?

For context, in addition to the issue linked by Carol

  • https://github.com/python/cpython/issues/119786

and the cpython PRs linked therein, there are already a couple of PRs in this repo:

  • #1334
  • #1339

The current content of the devguide's internals section and cpython's InternalDocs can be seen at:

  • https://devguide.python.org/internals/
  • https://github.com/python/cpython/tree/main/InternalDocs

Are there other parts of the devguide's internals section that still need to be moved/updated? Is https://github.com/python/cpython/issues/119786 still open pending the devguide changes, or are there more docs that need to be added/converted?

[^1]: Hosting it on GitHub might affect discoverability, since GitHub doesn't seem allow to allow crawlers on the source tree. To confirm, I tried searching for _PyInterpreterFrame and Tadaptive and while the former didn't yield any result in the InternalDocs, the latter did.

ezio-melotti avatar Jul 09 '24 03:07 ezio-melotti