Skip to content

Commit 8e9a24f

Browse files
jsquyresjsquyres
committed
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 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 <[email protected]>
1 parent 76b91ce commit 8e9a24f

File tree

4 files changed

+69
-52
lines changed

4 files changed

+69
-52
lines changed

‎docs/building-apps/deprecation-warnings.rst‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -93,7 +93,7 @@ listed :ref:`here <label-removed-mpi-constructs>`.
9393
- MPI-4.0 (2021)
9494

9595
* - :ref:`MPI_SIZEOF <label-mpi-sizeof>`
96-
- Fortran intrinsics``c_sizeof`` or ``storage_size``
96+
- Fortran intrinsics``c_sizeof`` or ``storage_size``
9797
- MPI-4.0 (2021)
9898

9999
.. _label-mpi-keyval-create:

‎docs/conf.py‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -225,3 +225,16 @@ def _doit(topdir):
225225
.. |deprecated_favor| replace:: this routine is deprecated in favor of
226226
227227
"""
228+
229+
# The sphinx_rtd_theme does not properly handle wrapping long lines in
230+
# table cells when rendering to HTML due to a CSS issue (see
231+
# https://github.com/readthedocs/sphinx_rtd_theme/issues/1505). Until
232+
# the issue is fixed upstream in sphinx_rtd_theme, we can simply
233+
# override the CSS here.
234+
rst_prolog += """
235+
.. raw:: html
236+
237+
<style>
238+
.wy-table-responsive table td,.wy-table-responsive table th{white-space:normal}
239+
</style>
240+
"""

‎docs/installing-open-mpi/required-support-libraries.rst‎

Lines changed: 20 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -7,37 +7,38 @@ Open MPI requires the following support libraries with the minimum listed versio
77

88
.. list-table::
99
:header-rows: 1
10-
:widths: 10 10 25
1110

1211
* - Library
1312
- Minimum version
1413
- Notes
1514
* - `Hardware Locality <https://www.open-mpi.org/projects/hwloc/>`_
1615
- |hwloc_min_version|
17-
- | This library is required; Open MPI will not build without it.
16+
- This library is required; Open MPI will not build without it.
1817
* - `Libevent <https://libevent.org/>`_
1918
- |event_min_version|
20-
- | This library is required; Open MPI will not build without it.
19+
- This library is required; Open MPI will not build without it.
2120
* - `PMIx <https://pmix.org/>`_
2221
- |pmix_min_version|
23-
- | This library is required; Open MPI will not build without it.
22+
- This library is required; Open MPI will not build without it.
2423
* - `PRRTE <https://github.com/openpmix/prrte>`_
2524
- |prte_min_version|
26-
- | This library is optional in some environments. PRRTE provides
27-
| Open MPI's full-featured ``mpirun`` / ``mpiexec`` MPI
28-
| application launchers (the two are identical; they are symbolic
29-
| links to the same executable).
30-
31-
* | If your environment uses another MPI application launcher
32-
| (e.g., Slurm users can use the ``srun`` launcher to "direct
33-
| launch" Open MPI applications), then the use of PRRTE is
34-
| optional.
35-
* | If your environment has no other MPI application launcher, then
36-
| you need to install PRRTE and build Open MPI with PRRTE
37-
| support.
38-
* | Open MPI can use the copy of PRRTE embedded in its source code
39-
| tree, or compile/link against an external PRRTE installation.
40-
| :ref:`See this section for details about how to specify each method <label-building-ompi-cli-options-required-support-libraries>`.
25+
- This library is optional in some environments. PRRTE provides
26+
Open MPI's full-featured ``mpirun`` / ``mpiexec`` MPI
27+
application launchers (the two are identical; they are symbolic
28+
links to the same executable).
29+
30+
* If your environment uses another MPI application launcher
31+
(e.g., Slurm users can use the ``srun`` launcher to "direct
32+
launch" Open MPI applications), then the use of PRRTE is
33+
optional.
34+
* If your environment has no other MPI application launcher, then
35+
you need to install PRRTE and build Open MPI with PRRTE
36+
support.
37+
* Open MPI can use the copy of PRRTE embedded in its source
38+
code tree, or compile/link against an external PRRTE
39+
installation. :ref:`See this section for details about how
40+
to specify each method
41+
<label-building-ompi-cli-options-required-support-libraries>`.
4142

4243
Since these support libraries are fundamental to Open MPI's operation
4344
and not universally available in all environments, they are directly

‎docs/launching-apps/ssh.rst‎

Lines changed: 35 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -203,35 +203,38 @@ shells are picky about the permissions of the startup file, for
203203
example). The list below contains some common shells and the startup
204204
files that they read/execute upon login:
205205

206-
.. error:: TODO This rendering sucks, but I couldn't make it play nice
207-
with list-table, either. :-(
208-
209-
* ``bash`` or ``zsh``:
210-
211-
* **Non-interactive login:** ``$HOME/.bashrc`` if it exists.
212-
* **Interactive login**: ``$HOME/.bash_profile`` if it exists, or
213-
``$HOME/.bash_login`` if it exists, or ``$HOME/.profile`` if it
214-
exists (in that order). Note that some Linux distributions
215-
automatically come with ``$HOME/.bash_profile`` scripts for users
216-
that automatically execute ``$HOME/.bashrc`` as well. Consult the
217-
bash man page for more information.
218-
219-
* ``sh``:
220-
221-
* **Non-interactive login:** This shell does not execute any file
222-
automatically, so Open MPI will execute the ``$HOME/.profile``
223-
script before invoking Open MPI executables on remote nodes
224-
* **Interactive login:** ``$HOME/.profile``
225-
226-
* ``csh``:
227-
228-
* **Non-interactive login:** ``$HOME/.cshrc``
229-
* **Interactive login:** ``$HOME/.cshrc`` followed by
230-
``$HOME/.login``
231-
232-
* ``tcsh``:
233-
234-
* **Non-interactive login:** ``$HOME/.tcshrc`` if it exists,
235-
``$HOME/.cshrc`` if it does not
236-
* **Interactive login:** ``$HOME/.tcshrc`` if it exists,
237-
``$HOME/.cshrc`` if it does not, followed by ``$HOME/.login``
206+
.. list-table::
207+
:header-rows: 1
208+
209+
* - Shell
210+
- Non-interactive login
211+
- Interactive login
212+
213+
* - ``bash`` or ``zsh``
214+
- ``$HOME/.bashrc`` if it exists.
215+
- #. ``$HOME/.bash_profile`` if it exists, or
216+
#. ``$HOME/.bash_login`` if it exists, or
217+
#. ``$HOME/.profile`` if it exists (in that order).
218+
219+
Note that some Linux distributions automatically come
220+
with ``$HOME/.bash_profile`` scripts for users that
221+
automatically execute ``$HOME/.bashrc`` as well. Consult the
222+
bash man page for more information.
223+
224+
* - ``sh``
225+
- This shell does not execute any file automatically, so Open MPI
226+
will execute the ``$HOME/.profile`` script before invoking Open
227+
MPI executables on remote nodes
228+
- ``$HOME/.profile``
229+
230+
* - ``csh``
231+
- ``$HOME/.cshrc``
232+
- ``$HOME/.cshrc`` followed by ``$HOME/.login``
233+
234+
* - ``tcsh``
235+
- #. ``$HOME/.tcshrc`` if it exists, or
236+
#. ``$HOME/.cshrc`` if it does not
237+
- #. ``$HOME/.tcshrc`` if it exists, or
238+
#. ``$HOME/.cshrc`` if it does not
239+
240+
Afterwards, execute ``$HOME/.login``

0 commit comments

Comments
 (0)