Skip to content

Commit

Permalink
Use code directive to escape code keywords
Browse files Browse the repository at this point in the history
  • Loading branch information
samjwu committed Nov 29, 2023
1 parent b9b639f commit 7be7e34
Show file tree
Hide file tree
Showing 2 changed files with 29 additions and 29 deletions.
56 changes: 28 additions & 28 deletions docs/API_Reference_Guide.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,61 +6,61 @@ Introduction
hiptensor Data Types
====================

hiptensorStatus_t
:code:`hiptensorStatus_t`
-----------------

.. doxygenenum:: hiptensorStatus_t

hiptensorComputeType_t
:code:`hiptensorComputeType_t`
----------------------

.. doxygenenum:: hiptensorComputeType_t

hiptensorOperator_t
:code:`hiptensorOperator_t`
-------------------

.. doxygenenum:: hiptensorOperator_t

hiptensorAlgo_t
:code:`hiptensorAlgo_t`
---------------

.. doxygenenum:: hiptensorAlgo_t

hiptensorWorksizePreference_t
:code:`hiptensorWorksizePreference_t`
-----------------------------

.. doxygenenum:: hiptensorWorksizePreference_t

hiptensorLogLevel_t
:code:`hiptensorLogLevel_t`
-------------------------------

.. doxygenenum:: hiptensorLogLevel_t

hiptensorHandle_t
:code:`hiptensorHandle_t`
-----------------

.. doxygenstruct:: hiptensorHandle_t
:members:

hiptensorTensorDescriptor_t
:code:`hiptensorTensorDescriptor_t`
---------------------------

.. doxygenstruct:: hiptensorTensorDescriptor_t
:members:

hiptensorContractionDescriptor_t
:code:`hiptensorContractionDescriptor_t`
--------------------------------

.. doxygenstruct:: hiptensorContractionDescriptor_t
:members:

hiptensorContractionFind_t
:code:`hiptensorContractionFind_t`
--------------------------

.. doxygenstruct:: hiptensorContractionFind_t
:members:

hiptensorContractionPlan_t
:code:`hiptensorContractionPlan_t`
--------------------------

.. doxygenstruct:: hiptensorContractionPlan_t
Expand All @@ -69,93 +69,93 @@ hiptensorContractionPlan_t
Helper Functions
================

hiptensorGetVersion
:code:`hiptensorGetVersion`
-------------------

.. doxygenfunction:: hiptensorGetVersion

hiptensorCreate
:code:`hiptensorCreate`
---------------

.. doxygenfunction:: hiptensorCreate

hiptensorDestroy
:code:`hiptensorDestroy`
----------------

.. doxygenfunction:: hiptensorDestroy

hiptensorInitTensorDescriptor
:code:`hiptensorInitTensorDescriptor`
-----------------------------

.. doxygenfunction:: hiptensorInitTensorDescriptor

hiptensorGetAlignmentRequirement
:code:`hiptensorGetAlignmentRequirement`
--------------------------------

.. doxygenfunction:: hiptensorGetAlignmentRequirement

hiptensorGetErrorString
:code:`hiptensorGetErrorString`
-----------------------

.. doxygenfunction:: hiptensorGetErrorString

Contraction Operations
======================

hiptensorInitContractionDescriptor
:code:`hiptensorInitContractionDescriptor`
----------------------------------

.. doxygenfunction:: hiptensorInitContractionDescriptor

hiptensorInitContractionFind
:code:`hiptensorInitContractionFind`
----------------------------

.. doxygenfunction:: hiptensorInitContractionFind

hiptensorInitContractionPlan
:code:`hiptensorInitContractionPlan`
----------------------------

.. doxygenfunction:: hiptensorInitContractionPlan

hiptensorContraction
:code:`hiptensorContraction`
--------------------

.. doxygenfunction:: hiptensorContraction

hiptensorContractionGetWorkspaceSize
:code:`hiptensorContractionGetWorkspaceSize`
------------------------------------

.. doxygenfunction:: hiptensorContractionGetWorkspaceSize

Logging Functions
=================

hiptensorLoggerSetCallback
:code:`hiptensorLoggerSetCallback`
--------------------------

.. doxygenfunction:: hiptensorLoggerSetCallback

hiptensorLoggerSetFile
:code:`hiptensorLoggerSetFile`
----------------------

.. doxygenfunction:: hiptensorLoggerSetFile

hiptensorLoggerOpenFile
:code:`hiptensorLoggerOpenFile`
-----------------------

.. doxygenfunction:: hiptensorLoggerOpenFile

hiptensorLoggerSetLevel
:code:`hiptensorLoggerSetLevel`
-----------------------

.. doxygenfunction:: hiptensorLoggerSetLevel

hiptensorLoggerSetMask
:code:`hiptensorLoggerSetMask`
----------------------

.. doxygenfunction:: hiptensorLoggerSetMask

hiptensorLoggerForceDisable
:code:`hiptensorLoggerForceDisable`
---------------------------

.. doxygenfunction:: hiptensorLoggerForceDisable
2 changes: 1 addition & 1 deletion docs/Linux_Install_Guide.rst
Original file line number Diff line number Diff line change
Expand Up @@ -125,7 +125,7 @@ Here are some other example project configurations:

After configuration, build with

cmake --build <build_dir> -- -j
:code:`cmake --build <build_dir> -- -j`


Build library + samples
Expand Down

0 comments on commit 7be7e34

Please sign in to comment.