From 3f7772ca400644b86765e4b58ce3c8ec4738c619 Mon Sep 17 00:00:00 2001 From: Jeff Squyres Date: Mon, 21 Aug 2023 09:45:24 -0400 Subject: [PATCH] docs: fix HTML word wapping in table cells 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 (in conf.py). The PRRTE docs don't use the RST ".. list-table::" directive much, so this change won't really have much of an effect here. However, OMPI and PMIx were updated with this conf.py change, so we might as well keep all 3 projects more-or-less in sync. Signed-off-by: Jeff Squyres (cherry picked from commit 9ef74786a57a7e579abb968287f2c3b3d9ed8139) --- docs/conf.py | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/docs/conf.py b/docs/conf.py index d169eaae0e..b4fbcc98b4 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -187,3 +187,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 + + +"""