Skip to content

gh-135755: Document __future__.* and CO_* as proper Sphinx objects #135980

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

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

encukou
Copy link
Member

@encukou encukou commented Jun 26, 2025

__future__ feature descriptions and CO_ C macros were documented in prose, but lacked Sphinx markup that marked them as Python attributes and C macros. For example:

  • Searching for “nested scopes” yields full-text results only
  • Searching for “CO_GENERATOR” yields “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/

@encukou encukou added docs Documentation in the Doc dir skip news needs backport to 3.13 bugs and security fixes labels Jun 26, 2025
@encukou encukou added the needs backport to 3.14 bugs and security fixes label Jun 26, 2025
@github-project-automation github-project-automation bot moved this to Todo in Docs PRs Jun 26, 2025
@bedevere-app bedevere-app bot mentioned this pull request Jun 26, 2025
38 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
awaiting core review docs Documentation in the Doc dir needs backport to 3.13 bugs and security fixes needs backport to 3.14 bugs and security fixes skip news
Projects
Status: Todo
Development

Successfully merging this pull request may close these issues.

1 participant