search

statsmodels / statsmodels.github.io

documentation for statsmodels - currently temporary structure and location
BSD 3-Clause "New" or "Revised" License
12 stars 9 forks source link

Title line overflows in doc #29

Open aryankeluskar opened 3 months ago

aryankeluskar commented 3 months ago

Describe the bug

While browsing the documentation for statsmodels, certain functions have really long names that overflow. The problem is the text doesn't wrap, causing some of the text to not be selectable or even visible (as showing in the image). Eg: https://www.statsmodels.org/stable/generated/statsmodels.regression.mixed_linear_model.MixedLM.html

Original:

image

Potential Fix 1:

I believe this could be a simple fix by enabling overflow to scroll. A potential solution could be adding the following to the documentation's CSS: 

overflow: scroll;
image

Potential Fix 2:

I believe this could also be a simple fix by enabling overflow-wrap to anywhere or break-word. A potential solution could be adding the following to the documentation's CSS: 

overflow-wrap: anywhere;
image
**Note**: As you can see, there are many issues on our GitHub tracker, so it is very possible that your issue has been posted before. Please check first before submitting so that we do not have to handle and close duplicates. **Note**: Please be sure you are using the latest released version of `statsmodels`, or a recent build of `main`. If your problem has been fixed in an unreleased version, you might be able to use `main` until a new release occurs. **Note**: If you are using a released version, have you verified that the bug exists in the main branch of this repository? It helps the limited resources if we know problems exist in the current main branch so that they do not need to check whether the code sample produces a bug in the next release.
bashtage commented 3 months ago

Would you be willing to propose this to the theme we use? Sphinx-immaterial.

aryankeluskar commented 3 months ago

No problem! I just saw that the CSS is being externally fed so I'll raise an issue with them as well, but would it possible for your website to override it till then?