-
-
Notifications
You must be signed in to change notification settings - Fork 2.1k
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
Py, use more desc_sig_* nodes #9672
Conversation
While the use of nodes is undocumented this may still break some themes, so perhaps there should be an "incompatible changes" entry as well? |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM with nits.
Any semi-trivial places I missed?
It seems OK. Let's fix them if we'll find them later.
While the use of nodes is undocumented this may still break some themes, so perhaps there should be an "incompatible changes" entry as well?
I think side effects are nothing or very less. But I'm not sure nobody gives styles to these classes. So it would be better to mention it.
1e90014
to
2e408cd
Compare
2e408cd
to
d4e3b28
Compare
8f864f8
to
2f1b388
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM with nits. Please merge this after fixing the typo.
Co-authored-by: Takeshi KOMIYA <i.tkomiya@gmail.com>
Feature or Bugfix
Purpose
A continuation of #9023, changing many parts of the Python domain to use more of the
addnodes.desc_sig_*
nodes for markup. This especially includes the use of the space node to make sure spaces are not swallowed if themes use alternative CSS (#9599).Detail
All of the changes are relatively simple, but it is not complete: the whole
pendinx_xref
handling is a bit more complicated than I dare to touch right now.TODO and Context
pending_xref`' handling. It seem like a name
A.B.Cbecomes a single xref with the content being a
nodes.Tex``.I think it would be good to change it to something like a
pending_xref
with targetA
and contentdesc_sig_name
withA
.
as punctuationpending_xref
with targetA.B
and contentdesc_sig_name
withB
.
as punctuationpending_xref
with targetA.B.C
and contentdesc_sig_name
withC
<span class="pre">
wrapping insphinx/sphinx/writers/html.py
Line 709 in 699d03f
sphinx/sphinx/writers/html5.py
Line 645 in 699d03f
Relates
sig-param
block #9599 (ping @mattip)