Skip to content

Conversation

miss-islington
Copy link
Contributor

@miss-islington miss-islington commented Jul 7, 2025

In typeobj.rst, instead of :c:member: it would be better to
use .. c:member:: with a :no-index: option, see:

See ref. https://www.sphinx-doc.org/en/master/usage/domains/index.html#basic-markup

However, c:member currently does not support :no-index:.
(cherry picked from commit 73e1207)

Co-authored-by: Petr Viktorin encukou@gmail.com


📚 Documentation preview 📚: https://cpython-previews--136377.org.readthedocs.build/

* pythongh-135913: Document ob_refcnt, ob_type, ob_size

In `typeobj.rst`, instead of `:c:member:` it would be better to
use `.. c:member::` with a `:no-index:` option, see:

See ref. https://www.sphinx-doc.org/en/master/usage/domains/index.html#basic-markup

However, `c:member` currently does not support `:no-index:`.
(cherry picked from commit 73e1207)

Co-authored-by: Petr Viktorin <encukou@gmail.com>
@bedevere-app bedevere-app bot added the docs Documentation in the Doc dir label Jul 7, 2025
@github-project-automation github-project-automation bot moved this to Todo in Docs PRs Jul 7, 2025
@encukou encukou merged commit 78e5d10 into python:3.14 Jul 8, 2025
33 checks passed
@github-project-automation github-project-automation bot moved this from Todo to Done in Docs PRs Jul 8, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs Documentation in the Doc dir skip news

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

2 participants