From 48ddb9523e3ebbc37bd7c707b7e9d16b72f3e31a Mon Sep 17 00:00:00 2001 From: randyh62 <42045079+randyh62@users.noreply.github.com> Date: Thu, 4 Jul 2024 08:29:01 -0700 Subject: [PATCH] Docs pick 6.2 (#756) * Bump rocm-docs-core from 0.38.1 to 1.0.0 in /docs/sphinx (#703) * Bump rocm-docs-core from 0.38.1 to 1.0.0 in /docs/sphinx Bumps [rocm-docs-core](https://github.com/RadeonOpenCompute/rocm-docs-core) from 0.38.1 to 1.0.0. - [Release notes](https://github.com/RadeonOpenCompute/rocm-docs-core/releases) - [Changelog](https://github.com/ROCm/rocm-docs-core/blob/develop/CHANGELOG.md) - [Commits](https://github.com/RadeonOpenCompute/rocm-docs-core/compare/v0.38.1...v1.0.0) --- updated-dependencies: - dependency-name: rocm-docs-core dependency-type: direct:production update-type: version-update:semver-major ... Signed-off-by: dependabot[bot] * Set Python 3.10 in ReadtheDocs config --------- Signed-off-by: dependabot[bot] Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: Sam Wu <22262939+samjwu@users.noreply.github.com> * Bump rocm-docs-core from 1.0.0 to 1.1.0 in /docs/sphinx (#706) Bumps [rocm-docs-core](https://github.com/RadeonOpenCompute/rocm-docs-core) from 1.0.0 to 1.1.0. - [Release notes](https://github.com/RadeonOpenCompute/rocm-docs-core/releases) - [Changelog](https://github.com/ROCm/rocm-docs-core/blob/develop/CHANGELOG.md) - [Commits](https://github.com/RadeonOpenCompute/rocm-docs-core/compare/v1.0.0...v1.1.0) --- updated-dependencies: - dependency-name: rocm-docs-core dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * Bump rocm-docs-core from 1.1.0 to 1.1.1 in /docs/sphinx (#709) Bumps [rocm-docs-core](https://github.com/RadeonOpenCompute/rocm-docs-core) from 1.1.0 to 1.1.1. - [Release notes](https://github.com/RadeonOpenCompute/rocm-docs-core/releases) - [Changelog](https://github.com/ROCm/rocm-docs-core/blob/develop/CHANGELOG.md) - [Commits](https://github.com/RadeonOpenCompute/rocm-docs-core/compare/v1.1.0...v1.1.1) --- updated-dependencies: - dependency-name: rocm-docs-core dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * Docs: fix links in installation and types guides (#708) * Fix links in installation and types * Change links to relative * Bump jinja2 from 3.1.3 to 3.1.4 in /docs/sphinx (#713) Bumps [jinja2](https://github.com/pallets/jinja) from 3.1.3 to 3.1.4. - [Release notes](https://github.com/pallets/jinja/releases) - [Changelog](https://github.com/pallets/jinja/blob/main/CHANGES.rst) - [Commits](https://github.com/pallets/jinja/compare/3.1.3...3.1.4) --- updated-dependencies: - dependency-name: jinja2 dependency-type: indirect ... Signed-off-by: dependabot[bot] Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * Bump rocm-docs-core from 1.1.1 to 1.1.2 in /docs/sphinx (#718) Bumps [rocm-docs-core](https://github.com/RadeonOpenCompute/rocm-docs-core) from 1.1.1 to 1.1.2. - [Release notes](https://github.com/RadeonOpenCompute/rocm-docs-core/releases) - [Changelog](https://github.com/ROCm/rocm-docs-core/blob/develop/CHANGELOG.md) - [Commits](https://github.com/RadeonOpenCompute/rocm-docs-core/compare/v1.1.1...v1.1.2) --- updated-dependencies: - dependency-name: rocm-docs-core dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * Bump rocm-docs-core from 1.1.2 to 1.1.3 in /docs/sphinx (#724) Bumps [rocm-docs-core](https://github.com/RadeonOpenCompute/rocm-docs-core) from 1.1.2 to 1.1.3. - [Release notes](https://github.com/RadeonOpenCompute/rocm-docs-core/releases) - [Changelog](https://github.com/ROCm/rocm-docs-core/blob/develop/CHANGELOG.md) - [Commits](https://github.com/RadeonOpenCompute/rocm-docs-core/compare/v1.1.2...v1.1.3) --- updated-dependencies: - dependency-name: rocm-docs-core dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * Bump requests from 2.31.0 to 2.32.2 in /docs/sphinx (#725) Bumps [requests](https://github.com/psf/requests) from 2.31.0 to 2.32.2. - [Release notes](https://github.com/psf/requests/releases) - [Changelog](https://github.com/psf/requests/blob/main/HISTORY.md) - [Commits](https://github.com/psf/requests/compare/v2.31.0...v2.32.2) --- updated-dependencies: - dependency-name: requests dependency-type: indirect ... Signed-off-by: dependabot[bot] Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * Bump rocm-docs-core from 1.1.3 to 1.2.0 in /docs/sphinx (#728) Bumps [rocm-docs-core](https://github.com/RadeonOpenCompute/rocm-docs-core) from 1.1.3 to 1.2.0. - [Release notes](https://github.com/RadeonOpenCompute/rocm-docs-core/releases) - [Changelog](https://github.com/ROCm/rocm-docs-core/blob/develop/CHANGELOG.md) - [Commits](https://github.com/RadeonOpenCompute/rocm-docs-core/compare/v1.1.3...v1.2.0) --- updated-dependencies: - dependency-name: rocm-docs-core dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * Bump rocm-docs-core from 1.2.0 to 1.3.0 in /docs/sphinx (#734) Bumps [rocm-docs-core](https://github.com/RadeonOpenCompute/rocm-docs-core) from 1.2.0 to 1.3.0. - [Release notes](https://github.com/RadeonOpenCompute/rocm-docs-core/releases) - [Changelog](https://github.com/ROCm/rocm-docs-core/blob/develop/CHANGELOG.md) - [Commits](https://github.com/RadeonOpenCompute/rocm-docs-core/compare/v1.2.0...v1.3.0) --- updated-dependencies: - dependency-name: rocm-docs-core dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * Bump rocm-docs-core from 1.3.0 to 1.4.0 in /docs/sphinx (#737) Bumps [rocm-docs-core](https://github.com/ROCm/rocm-docs-core) from 1.3.0 to 1.4.0. - [Release notes](https://github.com/ROCm/rocm-docs-core/releases) - [Changelog](https://github.com/ROCm/rocm-docs-core/blob/develop/CHANGELOG.md) - [Commits](https://github.com/ROCm/rocm-docs-core/compare/v1.3.0...v1.4.0) --- updated-dependencies: - dependency-name: rocm-docs-core dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * Bump urllib3 from 1.26.18 to 1.26.19 in /docs/sphinx (#743) Bumps [urllib3](https://github.com/urllib3/urllib3) from 1.26.18 to 1.26.19. - [Release notes](https://github.com/urllib3/urllib3/releases) - [Changelog](https://github.com/urllib3/urllib3/blob/1.26.19/CHANGES.rst) - [Commits](https://github.com/urllib3/urllib3/compare/1.26.18...1.26.19) --- updated-dependencies: - dependency-name: urllib3 dependency-type: indirect ... Signed-off-by: dependabot[bot] Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * Bump rocm-docs-core from 1.4.0 to 1.4.1 in /docs/sphinx (#754) Bumps [rocm-docs-core](https://github.com/ROCm/rocm-docs-core) from 1.4.0 to 1.4.1. - [Release notes](https://github.com/ROCm/rocm-docs-core/releases) - [Changelog](https://github.com/ROCm/rocm-docs-core/blob/develop/CHANGELOG.md) - [Commits](https://github.com/ROCm/rocm-docs-core/compare/v1.4.0...v1.4.1) --- updated-dependencies: - dependency-name: rocm-docs-core dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> --------- Signed-off-by: dependabot[bot] Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: Sam Wu <22262939+samjwu@users.noreply.github.com> Co-authored-by: peter --- .readthedocs.yaml | 2 +- docs/howto/index.rst | 2 +- docs/index.rst | 14 +++++++------- docs/installation/installlinux.rst | 8 ++++---- docs/reference/types.rst | 4 ++-- docs/sphinx/_toc.yml.in | 2 +- docs/sphinx/requirements.in | 2 +- docs/sphinx/requirements.txt | 8 ++++---- 8 files changed, 21 insertions(+), 21 deletions(-) diff --git a/.readthedocs.yaml b/.readthedocs.yaml index 9e6678abe..b3299fa4e 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -15,4 +15,4 @@ python: build: os: ubuntu-22.04 tools: - python: "3.8" + python: "3.10" diff --git a/docs/howto/index.rst b/docs/howto/index.rst index b45188875..ae81028cd 100644 --- a/docs/howto/index.rst +++ b/docs/howto/index.rst @@ -5,7 +5,7 @@ .. _user-guide: ******************************************************************** -How-To +How to ******************************************************************** This section provides guides on how to use the rocSOLVER library and its diff --git a/docs/index.rst b/docs/index.rst index acf2e7997..57a20bb21 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -8,12 +8,12 @@ rocSOLVER documentation ******************************************************************** -rocSOLVER is an implementation of `LAPACK routines `_ -on top of `AMD's open source ROCm platform `_. rocSOLVER is implemented in the -`HIP programming language `_ and optimized for AMD's +rocSOLVER is an implementation of `LAPACK routines `_ +on top of :doc:`AMD's open source ROCm platform `. rocSOLVER is implemented in the +:doc:`HIP programming language ` and optimized for AMD's latest discrete GPUs. -The code is open and hosted at: https://github.com/ROCm/rocSOLVER +The code is open and hosted at: ``__ The rocSOLVER documentation is structured as follows: @@ -24,7 +24,7 @@ The rocSOLVER documentation is structured as follows: * :ref:`install-linux` - .. grid-item-card:: How-to + .. grid-item-card:: How to * :ref:`using` * :ref:`memory` @@ -44,7 +44,7 @@ The rocSOLVER documentation is structured as follows: * :ref:`tuning_label` * :ref:`deprecated` -To contribute to the documentation refer to `Contributing to ROCm `_. +To contribute to the documentation refer to :doc:`Contributing to ROCm `. -You can find licensing information on the `Licensing `_ page. +You can find licensing information on the :doc:`Licensing ` page. diff --git a/docs/installation/installlinux.rst b/docs/installation/installlinux.rst index faa366725..81c49e2eb 100644 --- a/docs/installation/installlinux.rst +++ b/docs/installation/installlinux.rst @@ -12,11 +12,11 @@ Prerequisites ================= rocSOLVER requires a ROCm-enabled platform. For more information, see the -`ROCm install guide `_. +:doc:`ROCm install guide `. rocSOLVER also requires compatible versions of rocBLAS and rocSPARSE installed on the system. -For more information, see the `rocBLAS install guide `_ -and `rocSPARSE install guide `_. +For more information, see the :doc:`rocBLAS install guide ` +and :doc:`rocSPARSE install guide `. rocBLAS, rocSPARSE, and rocSOLVER are still under active development, and it is hard to define minimal compatibility versions. For now, a good rule of thumb is to always use rocSOLVER together with the @@ -43,7 +43,7 @@ rocSOLVER can be installed using a package manager. On Ubuntu, for example, use Building & installing from source ===================================== -The `rocSOLVER source code `_ is hosted +The `rocSOLVER source code `_ is hosted on GitHub. Download the code and checkout the desired branch using: .. code-block:: bash diff --git a/docs/reference/types.rst b/docs/reference/types.rst index 4e94241f2..75adaeea4 100644 --- a/docs/reference/types.rst +++ b/docs/reference/types.rst @@ -10,8 +10,8 @@ rocSOLVER Types rocSOLVER uses most types and enumerations defined in rocBLAS for the general operation and dense matrix computations, and some defined in rocSPARSE for sparse matrix computations (direct solvers). -For more information, see the `rocBLAS types `_ and -`rocSPARSE types `_ documentation. +For more information, see the :doc:`rocBLAS types ` and +:doc:`rocSPARSE types ` documentation. Next we present additional types, only used in rocSOLVER, that extend the rocBLAS and rocSPARSE APIs. diff --git a/docs/sphinx/_toc.yml.in b/docs/sphinx/_toc.yml.in index 22afca237..1fe22bd13 100644 --- a/docs/sphinx/_toc.yml.in +++ b/docs/sphinx/_toc.yml.in @@ -9,7 +9,7 @@ subtrees: - entries: - file: installation/installlinux.rst - file: howto/index.rst - title: How To + title: How to subtrees: - entries: - file: howto/using.rst diff --git a/docs/sphinx/requirements.in b/docs/sphinx/requirements.in index 0a3deabf4..c00b16b0e 100644 --- a/docs/sphinx/requirements.in +++ b/docs/sphinx/requirements.in @@ -1 +1 @@ -rocm-docs-core==0.38.1 +rocm-docs-core==1.4.1 diff --git a/docs/sphinx/requirements.txt b/docs/sphinx/requirements.txt index 0389fb57b..acce9514e 100644 --- a/docs/sphinx/requirements.txt +++ b/docs/sphinx/requirements.txt @@ -46,7 +46,7 @@ idna==3.7 # via requests imagesize==1.4.1 # via sphinx -jinja2==3.1.3 +jinja2==3.1.4 # via # myst-parser # sphinx @@ -88,11 +88,11 @@ pyyaml==6.0 # myst-parser # rocm-docs-core # sphinx-external-toc -requests==2.31.0 +requests==2.32.2 # via # pygithub # sphinx -rocm-docs-core==0.38.1 +rocm-docs-core==1.4.1 # via -r requirements.in smmap==5.0.0 # via gitdb @@ -135,7 +135,7 @@ sphinxcontrib-serializinghtml==1.1.5 # via sphinx typing-extensions==4.5.0 # via pydata-sphinx-theme -urllib3==1.26.18 +urllib3==1.26.19 # via requests wrapt==1.15.0 # via deprecated