Skip to content

Long project names/titles no longer wrap in left navigation (version 0.4.0rc1) #681

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
jonascj opened this issue Feb 15, 2023 · 2 comments · Fixed by #677
Closed

Long project names/titles no longer wrap in left navigation (version 0.4.0rc1) #681

jonascj opened this issue Feb 15, 2023 · 2 comments · Fixed by #677
Labels
bug Something isn't working

Comments

@jonascj
Copy link

jonascj commented Feb 15, 2023

Describe the bug

context
I was trying out sphinx-book-theme v. 0.4.0rc1 when I noticed that long project names/titles did no longer wrap in the left navigation panel.

Screenshot from 2023-02-15 13-18-46

expectation
The long name/title should wrap like it did in v. 0.3.3

Screenshot from 2023-02-15 13-21-04

bug
The difference (or bug) seem to be caused by the title-link no longer having the class text-wrap.

v0.4.0rc1

<a href="#" class="navbar-brand logo">
    <p class="title logo__title" style="/*! white-space: normal; */">Very Long and Complicated Project Name</p>
</a>

v0.3.3

<a href="#" class="navbar-brand logo text-wrap">
    <p class="title logo__title" style="/*! white-space: normal; */">Very Long and Complicated Project Name</p>
</a>

I am not sure if this is a problem with pydata-sphinx-theme, but I think not since the pydata-sphinx-theme has the project title in an element which is the full width of the page instead of a narrow left panel (https://pydata-sphinx-theme.readthedocs.io/en/stable/index.html).

problem
This is a problem for projects without logos or short names - like books.

This issue #624 is somewhat related, or at least adding the class text-wrap to the left navigation links would likely solve the issue.

Reproduce the bug

Build a project with a long title such as Very Long and Complicated Project Name and version 0.4.0rc1 of this theme. Notice how the title overflows the left navigation panel in the generated HTML-documentation (see the previous screenshot).

List your environment

I did not build with jupyter-book but with Sphinx (on Linux).

Sphinx version: 5.3.0
sphinx-book-theme version: 0.4.0rc1

@jonascj jonascj added the bug Something isn't working label Feb 15, 2023
@welcome
Copy link

welcome bot commented Feb 15, 2023

Thanks for opening your first issue here! Engagement like this is essential for open source projects! 🤗

If you haven't done so already, check out EBP's Code of Conduct. Also, please try to follow the issue template as it helps other community members to contribute more effectively.

If your issue is a feature request, others may react to it, to raise its prominence (see Feature Voting).

Welcome to the EBP community! 🎉

@choldgraf
Copy link
Member

good catch, will fix in #677

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants