diff --git a/docs/installation/install.rst b/docs/installation/install.rst index 3849b328..0f1c4c36 100644 --- a/docs/installation/install.rst +++ b/docs/installation/install.rst @@ -68,7 +68,7 @@ The rocSOLVER backend has the following dependencies: 4. `SuiteSparse `_ modules CHOLMOD and SuiteSparse_config (optional, required by default) rocSOLVER itself depends on rocBLAS and rocSPARSE, therefore all three libraries should be present with a standard rocSOLVER installation. For more information -about building and installing rocSOLVER, refer to the :doc:`rocSOLVER documentation `. +about building and installing rocSOLVER, refer to the :doc:`rocSOLVER documentation `. SuiteSparse is a third-party library, and can be installed using the package managers of most distros. Together with rocSPARSE, it is used to provide functionality for the hipsolverSp API. If only hipsolverDn and/or hipsolverRf are needed, these dependencies can be ignored by setting the ``BUILD_WITH_SPARSE`` diff --git a/docs/sphinx/_toc.yml.in b/docs/sphinx/_toc.yml.in index 10fefd37..dfd5975f 100644 --- a/docs/sphinx/_toc.yml.in +++ b/docs/sphinx/_toc.yml.in @@ -1,14 +1,16 @@ defaults: numbered: False root: index -entries: -- file: installation/index.rst +subtrees: +- caption: Install entries: - file: installation/install.rst -- file: howto/index.rst + +- caption: How to entries: - file: howto/usage.rst -- file: reference/index.rst + +- caption: Reference entries: - file: reference/intro.rst - file: reference/api/index.rst @@ -35,4 +37,7 @@ entries: - file: reference/refactor-api/types.rst - file: reference/refactor-api/helpers.rst - file: reference/refactor-api/refactor.rst -- file: license.rst + +- caption: About + entries: + - file: license.rst