diff --git a/docs/Contributors_Guide.rst b/docs/Contributors_Guide.rst index 212248be..87d71ce8 100644 --- 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 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 index ace565c1..7e0e7af5 100644 --- a/docs/Linux_Install_Guide.rst +++ b/docs/Linux_Install_Guide.rst @@ -125,7 +125,9 @@ Here are some other example project configurations: After configuration, build with - :code:`cmake --build -- -j` +.. code-block:: bash + + cmake --build -- -j Build library + samples @@ -133,11 +135,15 @@ Build library + samples To build library and samples, run the following command: - :code:`CC=hipcc CXX=hipcc cmake -B . -DHIPTENSOR_BUILD_TESTS=OFF -DHIPTENSOR_BUILD_SAMPLES=ON` +.. code-block:: bash + + CC=hipcc CXX=hipcc cmake -B . -DHIPTENSOR_BUILD_TESTS=OFF -DHIPTENSOR_BUILD_SAMPLES=ON After configuration, build with - :code:`cmake --build -- -j` +.. code-block:: bash + + cmake --build -- -j The samples folder in :code:`` 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 .` +.. code-block:: bash + + CC=hipcc CXX=hipcc cmake -B . After configuration, build with - :code:`cmake --build -- -j` +.. code-block:: bash + + cmake --build -- -j -The tests in `` contains executables in the table below. +The tests in :code:`` 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 index 047c1f5a..c873dda9 100644 --- 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/`