BlueBrain / BlueBrain/sphinx-bluebrain-theme

Doc readability: long names are truncated

Open
#70 1 comment 0 reactions 0 assignees View on GitHub
Dominant language
HTML
Stars
4
Forks
5
PR merge metrics
No merged PRs in 30d

Description

We've identified some layout issues that affect the readability of our documentation. Specifically, when we have classes or functions with long names, the text becomes truncated in both the left-hand and right-hand side panels. One possible solution could be implementing text wrapping for long names, allowing them to continue onto the next line instead of being cut off. In addition, the title text in the central panel sometimes overflows into the right-hand side panel. If appropriate, perhaps the font size could be reduced.
![Screenshot 2023-09-13 at 10 12 45](https://github.com/BlueBrain/sphinx-bluebrain-theme/assets/10600022/46c9a5e2-d280-4f5a-bc16-9670dbb3feb4)

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.