Merge pull request #160 from StreamHPC/docs_fix

Fix docs build error and warnings

.gitignore

@@ -60,3 +60,4 @@ _templates/
 _toc.yml
 docBin/
 _doxygen/
+.venv

docs/.doxygen/Doxyfile

@@ -2074,7 +2074,8 @@ INCLUDE_FILE_PATTERNS  =
 # recursively expanded use the := operator instead of the = operator.
 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
 
-PREDEFINED             = __device__
+PREDEFINED             = __device__ \
+                         DOXYGEN_SHOULD_SKIP_THIS
 
 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this
 # tag can be used to specify a list of macro names that should be expanded. The

docs/Contributors_Guide.rst

@@ -30,7 +30,7 @@ The hipTensor repository follows a workflow which dictates a /master branch wher
    the compute bound limit or memory bound limit.
 
 Style Guide
-==========
+===========
 
 This project follows the `CPP Core
 guidelines <https://github.com/isocpp/CppCoreGuidelines/blob/master/CppCoreGuidelines.md>`__,

docs/Programmers_Guide.rst

@@ -17,72 +17,72 @@ The `library` directory
 ^^^^^^^^^^^^^^^^^^^^^^^
 
 `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`
-''''''''''''''''''''''''''''''''''
+''''''''''''''''''''''''''''''''''''
 
 Internal include files for:
 
 - Utility Code
 - Generate Tensor Utility
 
 `library/src/`
-''''''''''''
+''''''''''''''
 
 Contains logger, device and performance functions.
 
 `library/src/contraction/`
-''''''''''''''''''''''''
+''''''''''''''''''''''''''
 
 Contains hipTensor core composable kernel header functions and contraction initialization functions.
 
 `library/src/contraction/device`
-''''''''''''''''''''''''''''''
+''''''''''''''''''''''''''''''''
 
 Contains hipTensor Bilinear and Scale instance functions
 
 The `samples` directory
 ^^^^^^^^^^^^^^^^^^^^^^^
 `01_contraction/simple_bilinear_contraction_f32.cpp`
-''''''''''''''''''''''''''''''''''''''''''''''''''
+''''''''''''''''''''''''''''''''''''''''''''''''''''
 
 sample code for calling bilinear contraction for :code:`fp32` input, output and compute types
 
 
 `01_contraction/simple_scale_contraction_f32.cpp`
-'''''''''''''''''''''''''''''''''''''''''''''''
+'''''''''''''''''''''''''''''''''''''''''''''''''
 
 sample code for calling scale contraction for :code:`fp32` input, output and compute types
 
 The `test` directory
 ^^^^^^^^^^^^^^^^^^^^^^^
 
 `00_unit/logger`
-''''''''''''''
+''''''''''''''''
 
 Test code for testing logger API Functions of hipTensor
 
 `01_contraction/bilinear_contraction_f32`
-'''''''''''''''''''''''''''''''''''''''
+'''''''''''''''''''''''''''''''''''''''''
 
 Test code for testing the bilinear contraction functionality and log metrics for F32 types.
 
 `01_contraction/bilinear_contraction_f64`
-'''''''''''''''''''''''''''''''''''''''
+'''''''''''''''''''''''''''''''''''''''''
 
 Test code for testing the bilinear contraction functionality and log metrics for F64 types.
 
 `01_contraction/scale_contraction_f32`
-''''''''''''''''''''''''''''''''''''
+''''''''''''''''''''''''''''''''''''''
 
 Test code for testing the scale contraction functionality and log metrics for F32 types.
 
 `01_contraction/scale_contraction_f64`
-''''''''''''''''''''''''''''''''''''
+''''''''''''''''''''''''''''''''''''''
 
 Test code for testing the scale contraction functionality and log metrics for F64 types.
 

library/include/hiptensor/internal/hiptensor-version.hpp.in

@@ -38,6 +38,15 @@
 #define HIPTENSOR_PATCH_VERSION       @hiptensor_VERSION_PATCH@
 // clang-format on
 
+/**
+ * \brief Returns the version number of hipTensor
+ *
+ * \details Return the version with three least significant digits for patch version,
+ * the next three digits for minor version, and the most significant digits for major version.
+ *
+ * \returns The version number.
+ */
+
 inline size_t hiptensorGetVersion()
 {
     return HIPTENSOR_MAJOR_VERSION * 1e6 + HIPTENSOR_MINOR_VERSION * 1e3 + HIPTENSOR_PATCH_VERSION;

library/include/hiptensor/internal/type_traits.hpp

@@ -93,6 +93,7 @@ namespace std
     ///////////  std::numeric_limits<float16_t>  //////////////
     ///////////////////////////////////////////////////////////
 
+#ifndef DOXYGEN_SHOULD_SKIP_THIS
     template <>
     HIPTENSOR_HOST_DEVICE constexpr hiptensor::float16_t
         numeric_limits<hiptensor::float16_t>::epsilon() noexcept
@@ -270,6 +271,7 @@ namespace std
         hiptensor::detail::Fp16Bits eps(static_cast<uint16_t>(0x7FC0));
         return eps.b16;
     }
+#endif // DOXYGEN_SHOULD_SKIP_THIS
 } // namespace std
 
 namespace hiptensor

library/src/contraction/contraction_solution_impl.hpp

@@ -35,11 +35,11 @@
 namespace std
 {
     template <>
-    struct std::hash<hiptensor::ContractionSolution>
+    struct hash<hiptensor::ContractionSolution>
     {
-        std::size_t operator()(hiptensor::ContractionSolution const& s) const noexcept
+        size_t operator()(hiptensor::ContractionSolution const& s) const noexcept
         {
-            return std::hash<hiptensor::ContractionSolutionParams>{}(*s.params());
+            return hash<hiptensor::ContractionSolutionParams>{}(*s.params());
         }
     };
 }

library/src/contraction/contraction_solution_params_impl.hpp

@@ -35,9 +35,9 @@
 namespace std
 {
     template <>
-    struct std::hash<hiptensor::ContractionSolutionParams>
+    struct hash<hiptensor::ContractionSolutionParams>
     {
-        std::size_t operator()(hiptensor::ContractionSolutionParams const& s) const noexcept
+        size_t operator()(hiptensor::ContractionSolutionParams const& s) const noexcept
         {
             return hiptensor::Hash{}(s.dimsM(),
                                      s.dimsN(),