Doc: Fix RST Syntax (#835)

* Doc: Fix RST Syntax Carefully fix RST Syntax in documentation, primarily for the `parameters.rst` file and in particular for nested bullet lists. Also fix other Sphinx warnings on the way. * Elements: Sub-Headings Makes this long list easier to read, creates a TOC entry for each element, and allow us to link to individual elements. * Sort Elements Alphabetically * Update add_element.rst * Update add_element.rst Links
BLAST-ImpactX · Feb 9, 2025 · b7a99e7 · b7a99e7
1 parent 0ef7039
commit b7a99e7
Show file tree

Hide file tree

Showing 5 changed files with 719 additions and 598 deletions.
diff --git a/docs/source/install/hpc/lumi.rst b/docs/source/install/hpc/lumi.rst
@@ -191,7 +191,7 @@ Use the following :ref:`cmake commands <building-cmake>` to compile the applicat
          cmake --fresh -S . -B build_lumi_cpu_py -DImpactX_FFT=ON -DImpactX_PYTHON=ON
          cmake --build build_lumi_cpu_py -j 16 --target pip_install
 
-Now, you can :ref:`submit LUMI compute jobs <running-cpp-lumi>` for ImpactX :ref:`Python scripts <usage-picmi>` (:ref:`example scripts <usage-examples>`).
+Now, you can :ref:`submit LUMI compute jobs <running-cpp-lumi>` for ImpactX :ref:`Python scripts <usage_run-user-interface>` (:ref:`example scripts <usage-examples>`).
 Or, you can use the ImpactX executables to submit LUMI jobs (:ref:`example inputs <usage-examples>`).
 For executables, you can reference their location in your :ref:`job script <running-cpp-lumi>` or copy them to a location in ``/project/$proj`` or ``/scratch/$proj``.
 

diff --git a/docs/source/usage/how_to_run.rst b/docs/source/usage/how_to_run.rst
@@ -4,6 +4,8 @@ Run ImpactX
 ===========
 
 
+.. _usage_run-tracking-mode:
+
 How to select a tracking mode
 -----------------------------
 
@@ -20,6 +22,8 @@ Reference Tracking Early Design    Reference orbit No
 ================== =============== =============== ==================
 
 
+.. _usage_run-user-interface:
+
 How to select a user interface
 ------------------------------
 
@@ -40,6 +44,8 @@ Dashboard   Beginner          Learning, Control-Systems Yes         No
 =========== ================= ========================= =========== =========== ============== ===========
 
 
+.. _usage_run-user-interface-how:
+
 How to run
 ----------
 
@@ -66,6 +72,8 @@ After installing ImpactX, run :ref:`one of our examples <usage-examples>`, e.g.,
          impactx-dashboard
 
 
+.. _usage_run-computing-system:
+
 How to select a computing system
 --------------------------------
 
@@ -86,6 +94,6 @@ As a rough guidance, they are best used for:
 ======== ========================================================= ======= =================
 Hardware Resolution needs                                          AI/ML   Energy Efficiency
 ======== ========================================================= ======= =================
-CPUs     Small (<10M particles) runs and coarse collective effects Yes     Low
-GPUs     Many (>10M) particles and/or detailed collective effects  Fastest High
+CPUs     Small (<10M particles) runs and coarse collective effects Yes     Lower
+GPUs     Many (>10M) particles and/or detailed collective effects  Fastest Higher
 ======== ========================================================= ======= =================