From 2fb9474ff0795019ce290eceab8b7ebdf64cab1d Mon Sep 17 00:00:00 2001 From: spolifroni-amd Date: Mon, 7 Jul 2025 10:29:36 -0400 Subject: [PATCH] updating the doxyfile and the index.rst so that it gets the full API (#2416) * updating the doxyfile and the index.rst so that it gets the full API * added recommended doxygen values [ROCm/composable_kernel commit: 096bf2de414d53c64a1a704869a24195c760814c] --- docs/doxygen/Doxyfile | 14 ++++++-------- docs/index.rst | 4 +++- 2 files changed, 9 insertions(+), 9 deletions(-) diff --git a/docs/doxygen/Doxyfile b/docs/doxygen/Doxyfile index 4367aabc95..4c8019f8d3 100644 --- a/docs/doxygen/Doxyfile +++ b/docs/doxygen/Doxyfile @@ -945,11 +945,9 @@ WARN_LOGFILE = # spaces. See also FILE_PATTERNS and EXTENSION_MAPPING # Note: If this tag is empty the current directory is searched. -INPUT = ../../include/ck/tensor_operation/gpu/grid \ - ../../include/ck/tensor_operation/gpu/block \ - ../../include/ck/tensor_operation/gpu/thread \ +INPUT = ../../include \ + ../../include/ck/ \ ../../library/include/ck/library/utility \ - ../../include/ck/wrapper \ ../../include/ck_tile # This tag can be used to specify the character encoding of the source files @@ -1849,7 +1847,7 @@ MATHJAX_CODEFILE = # The default value is: YES. # This tag requires that the tag GENERATE_HTML is set to YES. -SEARCHENGINE = YES +SEARCHENGINE = NO # When the SERVER_BASED_SEARCH tag is enabled the search engine will be # implemented using a web server instead of a web client using JavaScript. There @@ -2406,7 +2404,7 @@ TAGFILES = # tag file that is based on the input files it reads. See section "Linking to # external documentation" for more information about the usage of tag files. -GENERATE_TAGFILE = +GENERATE_TAGFILE = html/tagfile.xml # If the ALLEXTERNALS tag is set to YES, all external class will be listed in # the class index. If set to NO, only the inherited external classes will be @@ -2653,7 +2651,7 @@ DIR_GRAPH_MAX_DEPTH = 1 # The default value is: png. # This tag requires that the tag HAVE_DOT is set to YES. -DOT_IMAGE_FORMAT = png +DOT_IMAGE_FORMAT = svg # If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to # enable generation of interactive SVG images that allow zooming and panning. @@ -2665,7 +2663,7 @@ DOT_IMAGE_FORMAT = png # The default value is: NO. # This tag requires that the tag HAVE_DOT is set to YES. -INTERACTIVE_SVG = NO +INTERACTIVE_SVG = YES # The DOT_PATH tag can be used to specify the path where the dot tool can be # found. If left blank, it is assumed the dot tool can be found in the path. diff --git a/docs/index.rst b/docs/index.rst index 4cc26a1d3e..89a5e3e836 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -36,7 +36,9 @@ The Composable Kernel repository is located at `https://github.com/ROCm/composab * :doc:`Composable Kernel custom types <./reference/Composable_Kernel_custom_types>` * :doc:`Composable Kernel vector utilities <./reference/Composable_Kernel_vector_utilities>` * :ref:`wrapper` - * :doc:`Composable Kernel complete class list <./doxygen/html/annotated>` + * :doc:`Composable Kernel API reference <./doxygen/html/namespace_c_k>` + * :doc:`CK Tile API reference <./doxygen/html/namespaceck__tile>` + * :doc:`Composable Kernel complete API class list <./doxygen/html/annotated>` To contribute to the documentation refer to `Contributing to ROCm `_.