Skip to content
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

docs: fix HTML word wapping in table cells #11868

Conversation

jsquyres
Copy link
Member

@jsquyres jsquyres commented Aug 21, 2023

The sphinx_rtd_theme does not properly handle wrapping long lines in table cells when rendering to HTML due to a CSS issue (see readthedocs/sphinx_rtd_theme#1505).

Until the issue is fixed upstream in sphinx_rtd_theme, we can simply override the CSS here. This commit overrides the CSS in conf.py and also touches up some places where we previously tried to work around the lack of word wrapping.

REVIEWERS: You can compare the difference between the table at the tops of these pages:

The sphinx_rtd_theme does not properly handle wrapping long lines in
table cells when rendering to HTML due to a CSS issue (see
readthedocs/sphinx_rtd_theme#1505).

Until the issue is fixed upstream in sphinx_rtd_theme, we can simply
override the CSS here.  This commit overrides the CSS in conf.py and
also touches up some places where we previously tried to work around
the lack of word wrapping.

Signed-off-by: Jeff Squyres <jeff@squyres.com>
@jsquyres jsquyres force-pushed the pr/fix-sphinx-rtd-theme-table-cell-word-wrapping branch from 0d7b71d to 8e9a24f Compare August 21, 2023 18:27
Copy link
Contributor

@awlauria awlauria left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thanks!

@jsquyres jsquyres merged commit 0c1a20f into open-mpi:main Aug 21, 2023
10 checks passed
@jsquyres jsquyres deleted the pr/fix-sphinx-rtd-theme-table-cell-word-wrapping branch August 21, 2023 22:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants