Skip to content

Commit

Permalink
docs: fix HTML word wapping in table cells
Browse files Browse the repository at this point in the history
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>
(cherry picked from commit 9b3bdf8)
  • Loading branch information
jsquyres authored and rhc54 committed Sep 4, 2023
1 parent d495c26 commit 23f8dc6
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 4 deletions.
13 changes: 13 additions & 0 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -195,3 +195,16 @@
.. |flex_min_version| replace:: {flex_min_version}
"""

# The sphinx_rtd_theme does not properly handle wrapping long lines in
# table cells when rendering to HTML due to a CSS issue (see
# https://github.com/readthedocs/sphinx_rtd_theme/issues/1505). Until
# the issue is fixed upstream in sphinx_rtd_theme, we can simply
# override the CSS here.
rst_prolog += """
.. raw:: html
<style>
.wy-table-responsive table td,.wy-table-responsive table th{white-space:normal}
</style>
"""
8 changes: 4 additions & 4 deletions docs/installing-pmix/required-support-libraries.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,13 +14,13 @@ PMIx requires the following support libraries with the minimum listed versions:
- Notes
* - `Hardware Locality <https://www.open-mpi.org/projects/hwloc/>`_
- |hwloc_min_version|
- | This library is required; PMIx will not build without it.
- This library is required; PMIx will not build without it.
* - `Libevent <https://libevent.org/>`_
- |event_min_version|
- | Either libevent or libev must be provided
- Either libevent or libev must be provided
* - `libev <https://metacpan.org/dist/EV/view/libev/ev.pod>`_
- | no specified minimum
- | Either libevent or libev must be provided
- no specified minimum
- Either libevent or libev must be provided

These support libraries are fundamental to PMIx's operation
and pretty universally available in all environments. Worst case,
Expand Down

0 comments on commit 23f8dc6

Please sign in to comment.