gh-135755: Document __future__.* and CO_* as proper Sphinx objects #135980
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
This'll make it easier to add entries that need longer markup
encukou added docs 
39 tasks
encukou commented Jul 2, 2025
| Thanks @encukou for the PR 🌮🎉.. I'm working now to backport this PR to: 3.13, 3.14. |
miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Jul 7, 2025
…cts (pythonGH-135980) * Turn the __future__ table to list-table. This'll make it easier to add entries that need longer markup * Semantic markup for __future__ feature descriptions. * Document CO_* C macros. (cherry picked from commit 2468aaf) Co-authored-by: Petr Viktorin <encukou@gmail.com>
| Sorry, @encukou, I could not cleanly backport this to |
| GH-136370 is a backport of this pull request to the 3.14 branch. |
| GH-136371 is a backport of this pull request to the 3.13 branch. |
encukou added a commit to encukou/cpython that referenced this pull request Jul 7, 2025
…nx objects (pythonGH-135980) * Turn the __future__ table to list-table. This'll make it easier to add entries that need longer markup * Semantic markup for __future__ feature descriptions. * Document CO_* C macros. (cherry picked from commit 2468aaf) Co-authored-by: Petr Viktorin <encukou@gmail.com>
encukou added a commit that referenced this pull request Jul 7, 2025
…ects (GH-135980) (GH-136370) * Turn the __future__ table to list-table. This'll make it easier to add entries that need longer markup * Semantic markup for __future__ feature descriptions. * Document CO_* C macros. (cherry picked from commit 2468aaf) Co-authored-by: Petr Viktorin <encukou@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Add this suggestion to a batch that can be applied as a single commit. This suggestion is invalid because no changes were made to the code. Suggestions cannot be applied while the pull request is closed. Suggestions cannot be applied while viewing a subset of changes. Only one suggestion per line can be applied in a batch. Add this suggestion to a batch that can be applied as a single commit. Applying suggestions on deleted lines is not supported. You must change the existing code in this line in order to create a valid suggestion. Outdated suggestions cannot be applied. This suggestion has been applied or marked resolved. Suggestions cannot be applied from pending reviews. Suggestions cannot be applied on multi-line comments. Suggestions cannot be applied while the pull request is queued to merge. Suggestion cannot be applied right now. Please check back later.
__future__feature descriptions andCO_C macros were documented in prose, but lacked Sphinx markup that marked them as Python attributes and C macros. For example:inspect.CO_GENERATOR(Python data, in inspect — Inspect live objects)”, but no C API.This affects users of the Intersphinx inventory as well.
This patch adds the Sphinx definintions, and puts them in
list-tables to make the ReST more maintainabile.📚 Documentation preview 📚: https://cpython-previews--135980.org.readthedocs.build/