Fix spelling in documentation

ROCm · Nov 29, 2023 · b9b639f · b9b639f
1 parent 0b59b70
commit b9b639f
Show file tree

Hide file tree

Showing 5 changed files with 47 additions and 49 deletions.
diff --git a/docs/API_Reference_Guide.rst b/docs/API_Reference_Guide.rst
@@ -11,7 +11,6 @@ hiptensorStatus_t
 
 .. doxygenenum::  hiptensorStatus_t
 
-
 hiptensorComputeType_t
 ----------------------
 

diff --git a/docs/Contributors_Guide.rst b/docs/Contributors_Guide.rst
@@ -15,8 +15,7 @@ License Agreement
 Pull-request guidelines
 =======================
 
-
-Our code contriubtion guidelines closely follows the model of `GitHub
+Our code contribution guidelines closely follows the model of `GitHub
 pull-requests <https://help.github.com/articles/using-pull-requests/>`__.
 The hipTensor repository follows a workflow which dictates a /master branch where releases are cut, and a
 /develop branch which serves as an integration branch for new code. Pull requests should:
@@ -30,7 +29,7 @@ The hipTensor repository follows a workflow which dictates a /master branch wher
 -  code must also have benchmark tests, and performance must approach
    the compute bound limit or memory bound limit.
 
-StyleGuide
+Style Guide
 ==========
 
 This project follows the `CPP Core
@@ -44,16 +43,16 @@ Interface
 ---------
 
 -  Library code should use C++17
--  Avoid CamelCase
+-  Avoid Camel case
 -  This rule applies specifically to publicly visible APIs, but is also
    encouraged (not mandated) for internal code
 
 Philosophy
 ----------
 
 -  `P.2 <https://github.com/isocpp/CppCoreGuidelines/blob/master/CppCoreGuidelines.md#Rp-Cplusplus>`__:
-   Write in ISO Standard C++14 (especially to support windows, linux and
-   macos plaforms )
+   Write in ISO Standard C++14 (especially to support Windows, Linux and
+   macOS platforms )
 -  `P.5 <https://github.com/isocpp/CppCoreGuidelines/blob/master/CppCoreGuidelines.md#Rp-compile-time>`__:
    Prefer compile-time checking to run-time checking
 
@@ -105,19 +104,19 @@ will result in different results.
 
 To format a file, use:
 
-::
+.. code-block::
 
-    /opt/rocm/llvm/bin/clang-format -style=file -i <path-to-source-file>
+   /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::
 
-    #!/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
+   #!/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::
 
-    ./.githooks/install
+   ./.githooks/install
diff --git a/docs/Linux_Install_Guide.rst b/docs/Linux_Install_Guide.rst
@@ -104,9 +104,9 @@ Minimum ROCm version support is 5.7.
 
 By default, the project is configured as Release mode.
 
-To build only library, run the following comomand :
+To build only library, run the following command :
 
-    CC=hipcc CXX=hipcc cmake -B<build_dir> . -DHIPTENSOR_BUILD_TESTS=OFF -DHIPTENSOR_BUILD_SAMPLES=OFF
+    :code:`CC=hipcc CXX=hipcc cmake -B<build_dir> . -DHIPTENSOR_BUILD_TESTS=OFF -DHIPTENSOR_BUILD_SAMPLES=OFF`
 
 Here are some other example project configurations:
 
@@ -116,11 +116,11 @@ Here are some other example project configurations:
 +-----------------------------------+--------------------------------------------------------------------------------------------------------------------+
 |         Configuration             |                                          Command                                                                   |
 +===================================+====================================================================================================================+
-|            Basic                  |                                CC=hipcc CXX=hipcc cmake -B<build_dir> .                                            |
+|            Basic                  |                        :code:`CC=hipcc CXX=hipcc cmake -B<build_dir> .`                                            |
 +-----------------------------------+--------------------------------------------------------------------------------------------------------------------+
-|        Targeting gfx908           |                   CC=hipcc CXX=hipcc cmake -B<build_dir> . -DAMDGPU_TARGETS=gfx908:xnack-                          |
+|        Targeting gfx908           |           :code:`CC=hipcc CXX=hipcc cmake -B<build_dir> . -DAMDGPU_TARGETS=gfx908:xnack-`                          |
 +-----------------------------------+--------------------------------------------------------------------------------------------------------------------+
-|          Debug build              |                    CC=hipcc CXX=hipcc cmake -B<build_dir> . -DCMAKE_BUILD_TYPE=Debug                               |
+|          Debug build              |                    :code:`CC=hipcc CXX=hipcc cmake -B<build_dir> . -DCMAKE_BUILD_TYPE=Debug`                       |
 +-----------------------------------+--------------------------------------------------------------------------------------------------------------------+
 
 After configuration, build with
@@ -131,15 +131,15 @@ After configuration, build with
 Build library + samples
 ^^^^^^^^^^^^^^^^^^^^^^^
 
-To build library and samples, run the following comomand :
+To build library and samples, run the following command:
 
-    CC=hipcc CXX=hipcc cmake -B<build_dir> . -DHIPTENSOR_BUILD_TESTS=OFF -DHIPTENSOR_BUILD_SAMPLES=ON
+    :code:`CC=hipcc CXX=hipcc cmake -B<build_dir> . -DHIPTENSOR_BUILD_TESTS=OFF -DHIPTENSOR_BUILD_SAMPLES=ON`
 
 After configuration, build with
 
-    cmake --build <build_dir> -- -j
+    :code:`cmake --build <build_dir> -- -j`
 
-The samples folder in <build_dir> contains executables in the table below.
+The samples folder in :code:`<build_dir>` contains executables in the table below.
 
 =================================== ===================================================================================
 executable name                     description
@@ -154,13 +154,13 @@ Build library + tests
 
 To build library and tests, run the following command :
 
-    CC=hipcc CXX=hipcc cmake -B<build_dir> .
+    :code:`CC=hipcc CXX=hipcc cmake -B<build_dir> .`
 
 After configuration, build with
 
-    cmake --build <build_dir> -- -j
+    :code:`cmake --build <build_dir> -- -j`
 
-The tests in <build_dir> contains executables in the table below.
+The tests in `<build_dir>` contains executables in the table below.
 
 ====================================== ===================================================================================
 executable name                        description
@@ -177,6 +177,7 @@ Build library + Documentation
 
 Run the steps below to build documentation locally.
 
+.. code-block::
     cd docs
 
     sudo apt-get update
@@ -191,4 +192,4 @@ Run the steps below to build documentation locally.
 
     pdflatex hiptensor.tex
 
-Generates hiptensor.pdf here
+Generates :code:`hiptensor.pdf` here
diff --git a/docs/Programmers_Guide.rst b/docs/Programmers_Guide.rst
@@ -1,4 +1,3 @@
-
 ===================
 Programmer's Guide
 ===================
@@ -17,84 +16,84 @@ The hipTensor code is split into four major parts:
 The `library` directory
 ^^^^^^^^^^^^^^^^^^^^^^^
 
-library/include/hiptensor/
+`library/include/hiptensor/`
 '''''''''''''''''''''''''''
 
 Contains C++ include files for the hipTensor API. These files also contain Doxygen
 comments that document the API.
 
-library/include/hiptensor/internal
+`library/include/hiptensor/internal`
 ''''''''''''''''''''''''''''''''''
 
 Internal include files for:
 
 - Utility Code
 - Generate Tensor Utility
 
-library/src/
+`library/src/`
 ''''''''''''
 
 Contains logger, device and performance functions.
 
-library/src/contraction/
+`library/src/contraction/`
 ''''''''''''''''''''''''
 
 Contains hipTensor core composable kernel header functions and contraction initialization functions.
 
-library/src/contraction/device
+`library/src/contraction/device`
 ''''''''''''''''''''''''''''''
 
 Contains hipTensor Bilinear and Scale instance functions
 
 The `samples` directory
 ^^^^^^^^^^^^^^^^^^^^^^^
-01_contraction/simple_bilinear_contraction_f32.cpp
+`01_contraction/simple_bilinear_contraction_f32.cpp`
 ''''''''''''''''''''''''''''''''''''''''''''''''''
 
-sample code for calling bilinear contraction for fp32 input, output and compute types
+sample code for calling bilinear contraction for :code:`fp32` input, output and compute types
 
 
-01_contraction/simple_scale_contraction_f32.cpp
+`01_contraction/simple_scale_contraction_f32.cpp`
 '''''''''''''''''''''''''''''''''''''''''''''''
 
-sample code for calling scale contraction for fp32 input, output and compute types
+sample code for calling scale contraction for :code:`fp32` input, output and compute types
 
 The `test` directory
 ^^^^^^^^^^^^^^^^^^^^^^^
 
-00_unit/logger
+`00_unit/logger`
 ''''''''''''''
 
 Test code for testing logger API Functions of hipTensor
 
-01_contraction/bilinear_contraction_f32
+`01_contraction/bilinear_contraction_f32`
 '''''''''''''''''''''''''''''''''''''''
 
 Test code for testing the bilinear contraction functionality and log metrics for F32 types.
 
-01_contraction/bilinear_contraction_f64
+`01_contraction/bilinear_contraction_f64`
 '''''''''''''''''''''''''''''''''''''''
 
 Test code for testing the bilinear contraction functionality and log metrics for F64 types.
 
-01_contraction/scale_contraction_f32
+`01_contraction/scale_contraction_f32`
 ''''''''''''''''''''''''''''''''''''
 
 Test code for testing the scale contraction functionality and log metrics for F32 types.
 
-01_contraction/scale_contraction_f64
+`01_contraction/scale_contraction_f64`
 ''''''''''''''''''''''''''''''''''''
 
 Test code for testing the scale contraction functionality and log metrics for F64 types.
 
 Infrastructure
 ^^^^^^^^^^^^^^
 
-- 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:
+- 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:
 
-  - Doxygen comments in include files in the directory library/include
-  - files in the directory docs/
+  - Doxygen comments in include files in the directory :code:`library/include`
+  - files in the directory :code:`docs/`
 
 - Jenkins is used to automate Continuous Integration testing.
-- clang-format is used to format C++ code.
+- :code:`clang-format` is used to format C++ code.
diff --git a/docs/index.rst b/docs/index.rst
@@ -1,6 +1,6 @@
 ============================================================================
-hiptensor: A High-Performance HIP Library For Tensor Primitives
+hipTensor: A High-Performance HIP Library For Tensor Primitives
 ============================================================================
 
-hiptensor is AMD's C++ library for accelerating tensor primitives based on the
+hipTensor is AMD's C++ library for accelerating tensor primitives based on the
 composable kernel library, through general purpose kernel languages, like HIP C++.