fix spellcheck errors

ROCm · Dec 15, 2023 · 25191f5 · 25191f5
1 parent bcd81bd
commit 25191f5
Show file tree

Hide file tree

Showing 3 changed files with 23 additions and 12 deletions.
diff --git a/docs/Contributors_Guide.rst b/docs/Contributors_Guide.rst
@@ -104,19 +104,19 @@ will result in different results.
 
 To format a file, use:
 
-.. code-block::
+.. code-block:: bash
 
    /opt/rocm/llvm/bin/clang-format -style=file -i <path-to-source-file>
 
 To format all files, run the following script in hipTensor directory:
 
-.. code-block::
+.. code-block:: bash
 
    #!/bin/bash
    git ls-files -z *.cc *.cpp *.h *.hpp *.cl *.h.in *.hpp.in *.cpp.in | xargs -0 /opt/rocm/llvm/bin/clang-format -style=file -i
 
 Also, githooks can be installed to format the code per-commit:
 
-.. code-block::
+.. code-block:: bash
 
    ./.githooks/install
diff --git a/docs/Linux_Install_Guide.rst b/docs/Linux_Install_Guide.rst
@@ -125,19 +125,25 @@ Here are some other example project configurations:
 
 After configuration, build with
 
-    :code:`cmake --build <build_dir> -- -j`
+.. code-block:: bash
+
+    cmake --build <build_dir> -- -j
 
 
 Build library + samples
 ^^^^^^^^^^^^^^^^^^^^^^^
 
 To build library and samples, run the following command:
 
-    :code:`CC=hipcc CXX=hipcc cmake -B<build_dir> . -DHIPTENSOR_BUILD_TESTS=OFF -DHIPTENSOR_BUILD_SAMPLES=ON`
+.. code-block:: bash
+
+    CC=hipcc CXX=hipcc cmake -B<build_dir> . -DHIPTENSOR_BUILD_TESTS=OFF -DHIPTENSOR_BUILD_SAMPLES=ON
 
 After configuration, build with
 
-    :code:`cmake --build <build_dir> -- -j`
+.. code-block:: bash
+
+    cmake --build <build_dir> -- -j
 
 The samples folder in :code:`<build_dir>` contains executables in the table below.
 
@@ -154,13 +160,17 @@ Build library + tests
 
 To build library and tests, run the following command :
 
-    :code:`CC=hipcc CXX=hipcc cmake -B<build_dir> .`
+.. code-block:: bash
+
+    CC=hipcc CXX=hipcc cmake -B<build_dir> .
 
 After configuration, build with
 
-    :code:`cmake --build <build_dir> -- -j`
+.. code-block:: bash
+
+    cmake --build <build_dir> -- -j
 
-The tests in `<build_dir>` contains executables in the table below.
+The tests in :code:`<build_dir>` contains executables in the table below.
 
 ====================================== ===================================================================================
 executable name                        description
@@ -177,7 +187,8 @@ Build library + Documentation
 
 Run the steps below to build documentation locally.
 
-.. code-block::
+.. code-block:: bash
+
     cd docs
 
     sudo apt-get update

diff --git a/docs/Programmers_Guide.rst b/docs/Programmers_Guide.rst
@@ -89,8 +89,8 @@ Test code for testing the scale contraction functionality and log metrics for F6
 Infrastructure
 ^^^^^^^^^^^^^^
 
-- CMake is used to build and package hipTensor. There are :code:`CMakeLists.txt` files throughout the code.
-- `Doxygen/Breathe/Sphinx/ReadtheDocs` are used to produce documentation. Content for the documentation is from:
+- CMake is used to build and package hipTensor. There are ``CMakeLists.txt`` files throughout the code.
+- ``Doxygen/Breathe/Sphinx/ReadTheDocs`` are used to produce documentation. Content for the documentation is from:
 
   - Doxygen comments in include files in the directory :code:`library/include`
   - files in the directory :code:`docs/`