Merge pull request #501 from SwRaw/SR_rocRAND

organizing docs into subfolders
ROCm · Jun 5, 2024 · 7691501 · 7691501
2 parents a1a36a8 + 9af7828
commit 7691501
Show file tree

Hide file tree

Showing 11 changed files with 56 additions and 65 deletions.
diff --git a/LICENSE.txt b/LICENSE.txt
@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2017-2022 Advanced Micro Devices, Inc. All rights reserved.
+Copyright (c) 2017-2024 Advanced Micro Devices, Inc. All rights reserved.
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

diff --git a/docs/api-reference-home.rst b/docs/api-reference-home.rst
diff --git a/docs/cpp-api.rst → docs/api-reference/cpp-api.rst b/docs/cpp-api.rst → docs/api-reference/cpp-api.rst
@@ -10,6 +10,11 @@ C/C++ API reference
 
 This chapter describes the rocRAND C and C++ API.
 
+API index
+===========
+
+To search an API, refer to the API :ref:`genindex`.
+
 Device functions
 ================
 .. doxygengroup:: rocranddevice

diff --git a/docs/python-api.rst → docs/api-reference/python-api.rst b/docs/python-api.rst → docs/api-reference/python-api.rst
@@ -10,6 +10,11 @@ Python API reference
 
 This chapter describes the rocRAND Python module API.
 
+API index
+------------
+
+To search an API, refer to the API :ref:`genindex`.
+
 .. default-domain:: py
 .. py:currentmodule:: rocrand
 
@@ -45,3 +50,5 @@ Utilities
 .. autofunction:: rocrand.empty
 
 .. autofunction:: rocrand.get_version
+
+To search an API, refer to the :ref:`genindex` for all rocRAND APIs.
diff --git a/docs/curand-compatibility.rst → docs/conceptual/curand-compatibility.rst b/docs/curand-compatibility.rst → docs/conceptual/curand-compatibility.rst
diff --git a/docs/dynamic_ordering_configuration.rst → ...eptual/dynamic_ordering_configuration.rst b/docs/dynamic_ordering_configuration.rst → ...eptual/dynamic_ordering_configuration.rst
@@ -1,5 +1,11 @@
+.. meta::
+   :description: rocRAND documentation and API reference library
+   :keywords: rocRAND, ROCm, API, documentation
+
+.. _dynamic-ordering-configuration:
+
 =============================================================
-Generating optimal kernel configurations for dynamic ordering
+Kernel configurations for dynamic ordering
 =============================================================
 
 Overview

diff --git a/docs/programmers-guide.rst → docs/conceptual/programmers-guide.rst b/docs/programmers-guide.rst → docs/conceptual/programmers-guide.rst
diff --git a/docs/index.rst b/docs/index.rst
@@ -8,30 +8,39 @@
 rocRAND documentation
 ********************************************************************
 
-Welcome to the rocRAND docs home page! To learn more, see :ref:`what-is-rocrand`
+rocRAND provides functions that generate pseudo-random and quasi-random numbers. The rocRAND library is implemented in the `HIP <https://rocm.docs.amd.com/projects/HIP/en/latest/index.html>`_
+programming language and optimized for AMD's latest discrete GPUs. It is designed to run on top
+of AMD's `ROCm <https://rocm.docs.amd.com/en/latest/>`_, but it also works on CUDA-enabled GPUs.
 
-Our documentation is structured as follows:
+rocRAND includes a wrapper library called hipRAND, which you can use to easily port
+CUDA applications using the cuRAND library to the
+`HIP <https://rocm.docs.amd.com/projects/HIP/en/latest/index.html>`_ layer. In the
+`ROCm <https://rocm.docs.amd.com/en/latest/>`_ environment, hipRAND uses rocRAND.
+
+You can access rocRAND code on our `GitHub repository <https://github.com/ROCm/rocRAND>`_.
+
+The documentation is structured as follows:
 
 .. grid:: 2
   :gutter: 3
 
-  .. grid-item-card:: API reference
+  .. grid-item-card:: Install
 
-    * :ref:`cpp-api`
-    * :ref:`python-api`
-    * :ref:`curand-compatibility`
-    * :doc:`API library <doxygen/html/index>`
+    * :ref:`installing`
 
   .. grid-item-card:: Conceptual
 
-    * :ref:`programmers-guide`    
+    * :ref:`programmers-guide`
+    * :ref:`curand-compatibility`
+    * :ref:`dynamic-ordering-configuration`
 
-  .. grid-item-card:: Tutorial
+  .. grid-item-card:: API reference
 
-    * :ref:`installing`
+    * :ref:`cpp-api`
+    * :ref:`python-api`
+    * :doc:`API library <doxygen/html/index>`
 
-Contributing to this documentation
-=======================================================
+To contribute to the documentation, refer to
+`Contributing to ROCm  <https://rocm.docs.amd.com/en/latest/contribute/contributing.html>`_.
 
-We welcome collaboration! If you'd like to contribute to our documentation, you can find instructions on our `Contribute to ROCm docs <https://rocm.docs.amd.com/en/latest/contribute/index.html>`_ page. Known issues are listed on `GitHub <https://github.com/RadeonOpenCompute/ROCm/labels/Verified%20Issue>`_.
-Licensing information for all ROCm components is listed on our `Licensing <https://rocm.docs.amd.com/en/latest/about/license.html>`_ page.
+You can find licensing information on the `Licensing <https://rocm.docs.amd.com/en/latest/about/license.html>`_ page.
diff --git a/docs/installing.rst → docs/install/installing.rst b/docs/installing.rst → docs/install/installing.rst
diff --git a/docs/sphinx/_toc.yml.in b/docs/sphinx/_toc.yml.in
@@ -2,19 +2,19 @@
 # These comments will also be removed.
 root: index
 subtrees:
-  - entries:
-    - file: what-is-rocrand
-    - file: installing
-    - file: programmers-guide
-    - file: dynamic_ordering_configuration
-    - file: api-reference-home
-      title: API reference
-      subtrees:
-      - entries:
-        - file: cpp-api
-        - file: python-api
-        - file: curand-compatibility
-        - file: doxygen/html/index
+  - caption: Install
+    entries:
+    - file: install/installing
+  - caption: Conceptual
+    entries:
+    - file: conceptual/programmers-guide
+    - file: conceptual/curand-compatibility
+    - file: conceptual/dynamic_ordering_configuration
+  - caption: API reference
+    entries:
+    - file: api-reference/cpp-api
+    - file: api-reference/python-api
+    - file: doxygen/html/index
   - caption: About
     entries:
     - file: license
diff --git a/docs/what-is-rocrand.rst b/docs/what-is-rocrand.rst