Target [source] links more accurately in SASS #159
Conversation
Because `.viewcode-link` is already marked with `float: right` independently, don't assign that style redundantly when styling `[source]` links attached to function and class defintions. Use `.viewcode-link` instead of `a.reference.internal` to ensure that the styling for `[source]` links is not accidentally applied to return type annotations which are also internal references.
In conf.py, modify sys.path to add `kitchen_sink/demo_py/` This is the approach taken in the sphinx_rtd_theme in order to add an autodoc'ed module [1]. This module contains a class with one method and a function. This is more than enough to ensure that autodoc with type annotated methods and functions is exercised in furo. [1] https://github.com/readthedocs/sphinx_rtd_theme/blob/671703c3fbb5629fb5004afc941b59310976c28b/docs/conf.py#L10
|
I've added a page to the kitchen-sink demo which uses autodoc on an included module. I considered putting the desirable module in It does make furo's |
Now that the `.viewcode-link` selector is being used, it's not necessary to try to use `+` to find an adjacent element. The prior revision dropped this, but did not remove the selectors for elements neighboring the viewcode-link, resulting in the style not being applied.
|
I noticed that the sizes didn't look quite right in the above screenshot. I've pushed a separate commit with the fix, rather than rebasing or amending, to keep the history here clear. The first version of this PR did not apply the sizing properly to |
|
@pradyunsg, I just want to make sure this is on your radar. I think this is a good fix, and the overlap mentioned in #137 shows up in lots of places on our site's new build using furo. e.g.
|
|
Thanks for the persistence and clarity in the changes here @sirosen! |
This is a patch for #137
It works on the site where I tested it, and doesn't appear to break the kitchen-sink demo.
Because
.viewcode-linkis already marked withfloat: rightindependently, don't assign that style redundantly when styling[source]links attached to function and class defintions.Use
.viewcode-linkinstead ofa.reference.internalto ensure that the styling for[source]links is not accidentally applied to return type annotations which are also internal references.