Line breaks in function / class names (in autosummary tables)

Question

Line breaks in function / class names (in autosummary tables)

sikersten opened this issue 2 years ago · 6 comments

With insipid-sphinx-theme version >= 0.3.0, unwanted line breaks are in some cases inserted in function and class names before the last letter. For example

pyfar documentation created with older version: https://pyfar.readthedocs.io/en/v0.4.1/modules/pyfar.dsp.html
pyfar documentation created with version >= 0.3.0, including line breaks : https://pyfar.readthedocs.io/en/v0.4.2/modules/pyfar.dsp.html

Answer 1 · 2022-06-11T08:02:06.000Z

Thanks for reporting this!

I've changed the behavior in #72 and #87, because not breaking those lines is IMHO no option on small screens (like smartphones).

The problem now seems to be that the function name allows line breaks but the argument list doesn't, which looks very awkward.

Any ideas how to fix this?

Answer 2 · 2022-06-11T18:24:22.000Z

I've created #100, which is hopefully a bit better?

It's still not great, so if you have some suggestions, please let me know!

Answer 3 · 2022-06-19T10:04:47.000Z

I've just released version 0.3.2, can you please check if that improves the situation?

Again, if you have further suggestions, please let me know!

Answer 4 · 2022-06-22T09:17:42.000Z

Thank you for your effort and sorry for responding so late! It definitely improves the situation:
version 0.3.1:

version 0.3.2:

As you are asking for suggestions: now line breaks sometimes appear within parameter names (see above). Solutions for this I could think of would be to more strictly allow breaks only at "," or to shorten the parameter list depending of the length of the parameters and add something like "..." instead. But I am not familiar with how sphinx works.
What's your opinion?

Answer 5 · 2022-07-16T16:45:15.000Z

Thanks for checking this!

Solutions for this I could think of would be to more strictly allow breaks only at "," or to shorten the parameter list depending of the length of the parameters and add something like "..." instead.
But I am not familiar with how sphinx works.

The line breaks are not created by Sphinx but by the browser. So I guess any solution would have to be done using CSS.

If somebody knows how to improve the CSS rules, please let me know!

There are ways to cut off the end of a string and add "..." with CSS, but I think this will be confusing since some of the signatures already have "..." in them!

Answer 6 · 2022-08-27T20:52:07.000Z

I'm closing this for now. It's not perfect, but I think it's acceptable. If anybody has ideas for improvements, please speak up!