Merge pull request #18 from LLNL/task/doc-format-fixes

Fix formatting issues in user docs.

docs/sphinx/user_guide/build_and_test.rst

@@ -56,12 +56,13 @@ The CI expects a script that:
   ``scripts/gitlab`` in your project Git repo.
 * is parametrized by the variable ``SPEC`` which is used to prescribe a 
   Spack spec with the project name stripped out.
-* executes the project build and test processes:
-    # install dependencies and generate CMake configuration file
-      (using Spack as described earlier)
-    # configure a build with the configuration file and build the project
-      source code
-    # run the project tests
+* executes the following project build and test processes:
+
+    #. install dependencies and generate CMake configuration file
+       (using Spack as described earlier)
+    #. configure a build with the configuration file and build the project
+       source code
+    #. run the project tests
 
 The script should be callable to make it easier to test and debug. 
 For example:

docs/sphinx/user_guide/use_spack.rst

@@ -85,25 +85,25 @@ install your project dependencies and generate the configuration file.
 Getting Uberenv as a submodule (recommended)
 ============================================
 
-1. Get uberenv.py script.
+#. Get ``uberenv.py`` script.
 
     Use ``git submodule add`` to get `Uberenv`_ into a ``uberenv`` directory.
 
-2. Edit .uberenv.json.
+#. Edit ``.uberenv.json``.
 
     Create ``.uberenv.json`` in a directory that is a parent of ``uberenv``. Set
     your project package name, and other parameters like Spack reference
     commit/tag (we suggest the latest release tag).
 
-3. Add RADIUSS Spack Configs submodule.
+#. Add RADIUSS Spack Configs submodule.
 
     * Use ``git submodule add`` to get `RADIUSS Spack Configs`_ in a second
       submodule or custom location.
 
     * In ``.uberenv.json`` set ``spack_configs_path`` to point to
       ``<some_relative_path>/radiuss-spack-configs``.
 
-4. Add custom packages.
+#. Add custom packages.
 
     If you need to make local modifications to your project package or a
       dependency package, you may put it in a corresponding directory:
@@ -112,8 +112,8 @@ Getting Uberenv as a submodule (recommended)
     Then, in ``.uberenv.json``, set ``spack_packages_path`` to point to
       ``<some_relative_path>/packages``
 
-5. Make sure that <your_project>/package.py generates a CMake configuration
-   file.
+#. Make sure that the ``package.py`` file for your project generates a CMake 
+   configuration file.
 
     This is usually done adding a specific stage to the package. In particular,
     Spack now supports this for CMake build system with the CacheCMakePackages
@@ -124,31 +124,31 @@ Getting Uberenv as a submodule (recommended)
 Getting Uberenv by clone/fetch/copy
 ===================================
 
-1. Get uberenv.py script.
+#. Get ``uberenv.py`` script.
 
     Clone/Fetch/Copy it from `Uberenv`_ repository.
     into a ``uberenv`` directory, not as a submodule.
 
-2. Edit uberenv/project.json.
+#. Edit ``uberenv/project.json``.
 
     Set your project package name, and other parameters like Spack reference
     commit/tag (we suggest the latest release tag).
 
-3. Add RADIUSS Spack Configs submodule.
+#. Add RADIUSS Spack Configs submodule.
 
     * Use ``git submodule add`` to get `RADIUSS Spack Configs`_.
 
     * Create a symlink ``uberenv/spack_configs`` that points to
       ``radiuss-spack-configs``.
 
-4. Add custom packages.
+#. Add custom packages.
 
     | If you need to make local modifications to your project package or a
       dependency package, you may put it in a corresponding directory:
     | ``uberenv/packages/<package_name>/package.py``.
 
-5. Make sure that <your_project>/package.py generates a CMake configuration
-   file.
+#. Make sure that the ``package.py`` file for your project generates a CMake 
+   configuration file.
 
     This is usually done adding a specific stage to the package. In particular,
     Spack now supports this for CMake build system with the CacheCMakePackages