Skip to content
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

Docs for some C struct members repeat the struct name #97908

Closed
encukou opened this issue Oct 5, 2022 · 3 comments
Closed

Docs for some C struct members repeat the struct name #97908

encukou opened this issue Oct 5, 2022 · 3 comments
Labels
docs Documentation in the Doc dir

Comments

@encukou
Copy link
Member

encukou commented Oct 5, 2022

The members of PyType_Spec are documented as e.g. PyType_Spec.PyType_Spec.name:
image
This makes it cumbersome to link to them.
Fixing this will probably break URLs.

Linked PRs

@CAM-Gerlach
Copy link
Member

To note, in that issue the fragments visible to external links will change, unless we add ref target labels with the old name (which will generate anchors for them).

@encukou
Copy link
Member Author

encukou commented Dec 6, 2022

:ref: targets will not work, since Sphinx rewrites them (converts dots to dashes &c.)
I cant's see a better way to add old fragments than raw:: html. I guess this is HTML-specific, or at least hypertext-specific.

encukou added a commit that referenced this issue May 29, 2023
…H-100054)

And add raw HTML fragments to keep old links working.
miss-islington pushed a commit to miss-islington/cpython that referenced this issue May 29, 2023
…ocs (pythonGH-100054)

And add raw HTML fragments to keep old links working.
(cherry picked from commit 1668b41)

Co-authored-by: Petr Viktorin <encukou@gmail.com>
ambv pushed a commit that referenced this issue Jun 5, 2023
…docs (GH-100054) (#105057)

And add raw HTML fragments to keep old links working.
(cherry picked from commit 1668b41)

Co-authored-by: Petr Viktorin <encukou@gmail.com>
@hauntsaninja
Copy link
Contributor

Looks like this was completed, thanks!

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
Projects
None yet
Development

No branches or pull requests

3 participants