Closed
Description
The internals documentation is scattered in markdown files in the codebase, as well as parts which are in the dev guide. We would like to have it in one place, versioned along with the code (unlike the dev guide).
Linked PRs
- gh-119786: create folder in cpython repo for internals documentation #119787
- gh-119786: move exception handling doc to InternalDocs #119815
- gh-119786: move adaptive interpreter doc from Python to InternalsDoc #120137
- gh-119786: copy compiler doc from devguide to InternalDocs and convert to markdown #120134
- gh-119786: move locations doc to InternalDocs #120445
- gh-119786: move frames documentation to InternalDocs and add details #121009
- gh-119786: improve internal docs on
co_linetable#123198 - gh-119786: Edit
InternalDocs/frames.md,Python/vm-state.md,Python/tier2_engine.md#124450 - gh-119786: move a few more details on exception handling from devguide to InternalDocs #124989
- gh-119786: Move parser doc from devguide to InternalDocs #125119
- gh-119786: Move garbage collection doc from devguide to InternalDocs #125282
- gh-119786: move interpreter doc from devguide to InternalDocs #125715
- gh-119786: move 'changing grammar' checklist from devguide to InternalDocs #125874
- gh-119786:: move 'repo structure' and 'additional resources' from devguide to InternalDocs #125888
- gh-119786: add code object doc, inline locations.md into it #126832
- gh-119786: Add jit.md. Move adaptive.md to a section of interpreter.md. #127175
- gh-119786: Mention
InternalDocs/interpreter.mdinstead of non-existingadaptive.md#128329 - gh-119786: added InternalDocs/generators.md #128524
- gh-119786: Fix typo in
InternalDocs/string_interning.md#131203 - gh-119786: add
JUMP_BACKWARDmacro to the Jumps section #131213 - gh-119786: Fix _PyExecutorObject link at jit.md file #131382
Cosmetic PRs
- gh-119786: add links to code in exception handling doc #120077
- gh-119786: fix broken links in docs and comment #121601
- gh-119786: Replace a Sphinx role with literal syntax #124990
- gh-119786: [doc] broken link and typo fix in interpreter_definition.md #125455
- gh-119786: fix typo in compiler.md #125456
- gh-119786: [doc] more consistent syntax in InternalDocs #125815
- gh-119786: cleanup internal docs and fix internal links #127485
- gh-119786: fix miscellaneous typos in
interpreter_definition.md#127957 - gh-119786: fix typos in
InternalDocs/interpreter.md#128174 - gh-119786: Fix typos in
InternalDocs/frames.md#128275 - gh-119786: Fix typos in
InternalDocs/parser.md#128314