From 05c5d9e2ca11e879c834d1dd03b6c88641f41046 Mon Sep 17 00:00:00 2001 From: randyh62 <42045079+randyh62@users.noreply.github.com> Date: Tue, 12 Mar 2024 18:25:48 -0700 Subject: [PATCH] Doc reorg2 (#1189) * doc_reorg2 updated TOC * doc_reorg2 updates * fix conflicts, add grid [ROCm/composable_kernel commit: 12441af014d8c865a0254efea3f82a07bdf58b4f] --- docs/{ => conceptual}/what-is-ck.rst | 4 +-- docs/index.rst | 25 +++++++------- docs/{ => install}/dockerhub.rst | 0 docs/license.md | 2 -- docs/license.rst | 11 +++++++ docs/{ => reference}/API_Reference_Guide.rst | 0 .../Supported_Primitives_Guide.rst | 0 docs/{ => reference}/wrapper.rst | 0 docs/sphinx/_toc.yml.in | 33 ++++++++++++++----- docs/{ => tutorial}/tutorial_hello_world.rst | 0 10 files changed, 49 insertions(+), 26 deletions(-) rename docs/{ => conceptual}/what-is-ck.rst (94%) rename docs/{ => install}/dockerhub.rst (100%) delete mode 100644 docs/license.md create mode 100644 docs/license.rst rename docs/{ => reference}/API_Reference_Guide.rst (100%) rename docs/{ => reference}/Supported_Primitives_Guide.rst (100%) rename docs/{ => reference}/wrapper.rst (100%) rename docs/{ => tutorial}/tutorial_hello_world.rst (100%) diff --git a/docs/what-is-ck.rst b/docs/conceptual/what-is-ck.rst similarity index 94% rename from docs/what-is-ck.rst rename to docs/conceptual/what-is-ck.rst index f0b51c48f8..36785fc6ca 100644 --- a/docs/what-is-ck.rst +++ b/docs/conceptual/what-is-ck.rst @@ -20,7 +20,7 @@ CK utilizes two concepts to achieve performance portability and code maintainabi * Algorithm complexity reduction for complex ML operators using an innovative technique called "Tensor Coordinate Transformation". -.. image:: data/ck_component.png +.. image:: ../data/ck_component.png :alt: CK Components @@ -36,6 +36,6 @@ The CK library is structured into 4 layers: It also includes a simple wrapper component used to perform tensor transform operations more easily and with fewer lines of code. -.. image:: data/ck_layer.png +.. image:: ../data/ck_layer.png :alt: CK Layers \ No newline at end of file diff --git a/docs/index.rst b/docs/index.rst index 8ae4ce3a22..55c80b8edf 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -12,27 +12,26 @@ The Composable Kernel (CK) library provides a programming model for writing perf The CK documentation is structured as follows: -.. card:: Conceptual +.. grid:: 2 + :gutter: 3 - * :ref:`what-is-ck` + .. grid-item-card:: Installation -.. card:: Installation + * :ref:`docker-hub` - * :ref:`docker-hub` + .. grid-item-card:: Conceptual -.. card:: Tutorial + * :ref:`what-is-ck` - * :ref:`hello-world` + .. grid-item-card:: API reference -.. card:: API reference + * :ref:`supported-primitives` + * :ref:`api-reference` + * :ref:`wrapper` - * :ref:`supported-primitives` - * :ref:`api-reference` - * :ref:`wrapper` + .. grid-item-card:: Tutorial -.. card:: Contributing to CK - - * :ref:`contributing-to` + * :ref:`hello-world` To contribute to the documentation refer to `Contributing to ROCm `_. diff --git a/docs/dockerhub.rst b/docs/install/dockerhub.rst similarity index 100% rename from docs/dockerhub.rst rename to docs/install/dockerhub.rst diff --git a/docs/license.md b/docs/license.md deleted file mode 100644 index 43e471da0e..0000000000 --- a/docs/license.md +++ /dev/null @@ -1,2 +0,0 @@ -```{include} ../LICENSE.md -``` diff --git a/docs/license.rst b/docs/license.rst new file mode 100644 index 0000000000..1e5389ccc1 --- /dev/null +++ b/docs/license.rst @@ -0,0 +1,11 @@ +.. meta:: + :description: Composable Kernel documentation and API reference library + :keywords: composable kernel, CK, ROCm, API, documentation + +.. _license: + +******************************************************************** +License +******************************************************************** + +.. include:: ../LICENSE \ No newline at end of file diff --git a/docs/API_Reference_Guide.rst b/docs/reference/API_Reference_Guide.rst similarity index 100% rename from docs/API_Reference_Guide.rst rename to docs/reference/API_Reference_Guide.rst diff --git a/docs/Supported_Primitives_Guide.rst b/docs/reference/Supported_Primitives_Guide.rst similarity index 100% rename from docs/Supported_Primitives_Guide.rst rename to docs/reference/Supported_Primitives_Guide.rst diff --git a/docs/wrapper.rst b/docs/reference/wrapper.rst similarity index 100% rename from docs/wrapper.rst rename to docs/reference/wrapper.rst diff --git a/docs/sphinx/_toc.yml.in b/docs/sphinx/_toc.yml.in index 5780674624..533b81cd39 100644 --- a/docs/sphinx/_toc.yml.in +++ b/docs/sphinx/_toc.yml.in @@ -2,20 +2,35 @@ defaults: numbered: False root: index subtrees: -- entries: - - file: what-is-ck.rst + +- caption: Conceptual + entries: + - file: conceptual/what-is-ck.rst title: What is Composable Kernel? - - file: dockerhub.rst + +- caption: Install + entries: + - file: install/dockerhub.rst title: Docker Hub - - file: tutorial_hello_world.rst - title: Hello World Tutorial - - file: Supported_Primitives_Guide.rst + +- caption: CK API Reference + entries: + - file: reference/Supported_Primitives_Guide.rst title: Supported Primitives - - file: API_Reference_Guide.rst + - file: reference/API_Reference_Guide.rst title: API Reference - - file: wrapper.rst + - file: reference/wrapper.rst title: Wrapper + +- caption: Tutorial + entries: + - file: tutorial/tutorial_hello_world.rst + title: Hello World Tutorial + +- caption: About + entries: - file: Contributors_Guide.rst title: Contributing to CK - - file: license.md + - file: license.rst title: License + \ No newline at end of file diff --git a/docs/tutorial_hello_world.rst b/docs/tutorial/tutorial_hello_world.rst similarity index 100% rename from docs/tutorial_hello_world.rst rename to docs/tutorial/tutorial_hello_world.rst