Overlap of return annotation with [source]

[harshil21]

What's happening?

When using linkcode to attach the [source] for each method, and when using autodoc-process-signature to manually generate a custom return annotation, there is an UI overlap of both those elements.

My html_theme_options (unrelated to above but still):

html_theme_options = {
    # 'style_external_links': True,  # Use after https://github.com/pradyunsg/furo/discussions/348
    'navigation_with_keys': True,
    'dark_css_variables': {'admonition-title-font-size': '0.95rem',
                           'admonition-font-size': '0.92rem'},
    'light_css_variables': {'admonition-title-font-size': '0.95rem',
                            'admonition-font-size': '0.92rem'}
}

autodoc_type_hints is set to none.

Furo version: 2022.1.2
Sphinx version: 4.3.2

Reproducer

1. Clone https://github.com/harshil21/python-telegram-bot.git
2. Switch to the dark-mode-adjust branch (git checkout dark-mode-adjust)
3. Run the command make -C docs html
4. Now after the docs are generated, open docs/build/html/telegram.bot.html in a browser
5. Search or scroll down to the method forwardMessage
6. See the UI bug.

---

Another place where it happens with the type annotation of the method:
See (https://python-telegram-bot.readthedocs.io/en/doc-fixes/telegram.ext.updater.html#telegram.ext.Updater.idle)

1. Clone https://github.com/python-telegram-bot/python-telegram-bot.git
2. Follow above steps
3. Open docs/build/html/telegram.ext.updater.html in a browser
4. Search or scroll down to the method idle
5. See the same UI bug

Expectation

Furo should recognize that there will be an overlap and put it in the next line, like it did below:

Code of Conduct

• I agree to follow the Code of Conduct.

[Bibo-Joshi]

IISc with autodoc_type_hints=None, the return type shouldn't show at all, right?

[harshil21]

right, I was testing showing only the return annotation using autodoc-process-signature

[pradyunsg]

Will commit changes to remote soon, so I'll edit this then

There's nothing actionable here for me until then. I won't be able to change things unless I'm able to reproduce this.

[harshil21]

I've edited the OP with instructions to reproduce :)

[francois-rozet]

Hello @pradyunsg,

On the same subject, if the last line overlaps with the [source], the latter is forced out of the signature which is quite ugly.

I tried to come up with a CSS-only fix, but it never worked because the permalink tag comes after the [source] link in the HTML.

The solution I have currently consists in

1. swapping the two elements (a.reference <-> a.headerlink) with sed after the HTML is generated and

2. modifying the CSS such that the permalink cannot overlap with the [source].

   .sig > a.headerlink:not(:last-child) {
       margin-right: 5em;
   }
   
   .sig > a.reference {
       float: right;
       width: 0;
   }

Do you think it would be possible to add the "swap" in Furo ?

[pradyunsg]

I investigated this today, and managed to reproduce this. c718f86 makes this work correctly and should be doing what we want here. :)

[francois-rozet]

Hello @pradyunsg, I am not sure that your fix works. Just adding two more as makes the [source] link overflow out of the signature.

As mentioned in a previous comment, the only reliable fix I found was to swap the order of the permalink (#) and source link in HTML.

[pradyunsg]

That markup comes directly from Sphinx, and I've in-general avoided doing HTML transformation for things like that in this theme.