Fix docs rendering issue (#349)

docs/README.md

@@ -6,7 +6,7 @@ To build html documentation locally:
 
 ```
 brew install doxygen sphinx-doc
-pip3.10 install -r ./requirements.txt
+pip3.10 install -r ./sphinx/requirements.txt
 python3.10 -m sphinx -T -E -b html -d _build/doctrees -D language=en . _build/html
 open _build/html/index.html
 ```
@@ -15,7 +15,7 @@ To build pdf documentation we require a LaTeX installation on your machine.
 Once LaTeX is installed, you may run the following:
 
 ```
-pip3.10 install -r ./requirements.txt
+pip3.10 install -r ./sphinx/requirements.txt
 sphinx-build -M latexpdf . _build
 open _build/latex/rocshmem.pdf
 ```

docs/api/env_variables.rst

@@ -38,7 +38,7 @@ control the behavior of rocSHMEM.
     * - | ``ROCSHMEM_BACKEND``
         | When rocSHMEM is compiled for all backends, this enviroment variable
         | selects which backend to execute. Default is auto-selection
-      - ````
+      - `` ``
       - | ipc: IPC Backend
         | ro: Reverse Offload Backend
         | gda: GPU Direct Async Backend
@@ -57,22 +57,22 @@ control the behavior of rocSHMEM.
 
     * - | ``ROCSHMEM_USE_IB_HCA``
         | Defines which NIC that this PE should be bound to
-      - ``0``
+      - `` ``
       - | Example value: `bnxt_re0`
 
     * - | ``ROCSHMEM_BOOTSTRAP_SOCKET_IFNAME``
         | Chooses the interface to bootstrap rocSHMEM with.
         | Only valid when not using MPI.
         | The default value is an empty string and rocSHMEM auto-detects the most appropriate interface.
-      - ````
+      - `` ``
       - | Example value: `eno8303`
 
     * - | ``ROCSHMEM_GDA_PROVIDER``
         | When rocSHMEM is compiled with support for multiple NIC vendors,
         | the enviroment variable selects the desired provider.
         | The default value is an empty string and rocSHMEM auto-detects the most appropriate NIC.
-      - ````
-        | bnxt: Broadcom Thor 2
+      - `` ``
+      - | bnxt: Broadcom Thor 2
         | pensando: AMD Pensando Pollara
         | ionic: AMD Pensando Pollara (alias)
         | mlx5: Mellanox ConnectX-7

docs/api/memory_ordering.rst

@@ -36,7 +36,7 @@ ROCSHMEM_QUIET
 This routine completes all previous operations posted to this context.
 
 ROCSHMEM_PE_QUIET
---------------
+-----------------
 
 .. cpp:function:: __device__ void rocshmem_ctx_pe_quiet(shmem_ctx_t ctx, const int *target_pes, size_t npes)
 .. cpp:function:: __device__ void rocshmem_pe_quiet(const int *target_pes, size_t npes)

docs/compile_and_run.rst

@@ -40,7 +40,7 @@ If your project uses CMake, see
 `Using CMake with AMD ROCm <https://rocmdocs.amd.com/en/latest/conceptual/cmake-packages.html>`_.
 
 Running a rocSHMEM application
---------------------------
+------------------------------
 
 Applications using rocSHMEM typically deploy multiple processes, usually one per GPU.
 The MPI launcher, for example, ``mpiexec`` with Open MPI, is used to start the required number

docs/install.rst

@@ -11,7 +11,7 @@ Installing rocSHMEM
 This topic describes how to install rocSHMEM.
 
 Requirements
----------------------------
+------------
 
 * ROCm 6.4.0 or later, including the :doc:`HIP runtime <hip:index>`. For more information, see `ROCm installation for Linux <https://rocm.docs.amd.com/projects/install-on-linux/en/latest/>`_.
 
@@ -64,10 +64,10 @@ On Ubuntu, you can install rocSHMEM by running:
 .. _install-dependencies:
 
 Building dependencies
----------------------------
+---------------------
 
 GDA NIC Dependencies
-^^^^^^^^^^^^^^^^
+^^^^^^^^^^^^^^^^^^^^
 
 - GDA on Mellanox NICs should work on any recent version of rdma-core.
 - GDA on Broadcom Thor requires driver version 233.2.108.0 and firmware version 233.2.104.0 or later.
@@ -128,7 +128,7 @@ However, it is important to note that this will disable the functional and unit
 tests as they required MPI to run.
 
 All Backends build
-^^^^^^^^^^^^^^^^^^^^
+^^^^^^^^^^^^^^^^^^
 
 To build and install rocSHMEM with all three backends, run:
 
@@ -147,7 +147,7 @@ The build script passes configuration options to CMake to set up a canonical bui
  This will build rocSHMEM with all backends, you can select the IPC, RO, GDA, or a combination at runtime. However there is a small performance penality for this portability. The other build scripts are recommended if you are trying to achive maximum performance.
 
 GDA backend build
-^^^^^^^^^^^^^^^^^^^^
+^^^^^^^^^^^^^^^^^
 
 To build and install rocSHMEM with the GDA backends, run:
 
@@ -168,7 +168,7 @@ To build and install rocSHMEM with the GDA backends, run:
 The build script passes configuration options to CMake to set up a canonical build.
 
 RO and IPC backend build
-^^^^^^^^^^^^^^^^^^^^
+^^^^^^^^^^^^^^^^^^^^^^^^
 
 To build and install rocSHMEM with the hybrid RO (off-node) and IPC (on-node) backends, run: