Skip to content

Commit

Permalink
Cherry picking documentation updates from develop to 6.2 (#374)
Browse files Browse the repository at this point in the history 
* Update RTD config to use Python 3.10 and rocm-docs-core 1.1.1 (#359)

* Add doc team as codeowner for RTD yaml config

* Update RTD config to use Python 3.10 and rocm-docs-core 1.1.1

* Bump idna from 3.4 to 3.7 in /docs/sphinx (#356)

Bumps [idna](https://github.com/kjd/idna) from 3.4 to 3.7.
- [Release notes](https://github.com/kjd/idna/releases)
- [Changelog](https://github.com/kjd/idna/blob/master/HISTORY.rst)
- [Commits](kjd/idna@v3.4...v3.7)

---
updated-dependencies:
- dependency-name: idna
  dependency-type: indirect
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* Bump tqdm from 4.65.0 to 4.66.3 in /docs/sphinx (#358)

Bumps [tqdm](https://github.com/tqdm/tqdm) from 4.65.0 to 4.66.3.
- [Release notes](https://github.com/tqdm/tqdm/releases)
- [Commits](tqdm/tqdm@v4.65.0...v4.66.3)

---
updated-dependencies:
- dependency-name: tqdm
  dependency-type: indirect
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* Bump jinja2 from 3.1.3 to 3.1.4 in /docs/sphinx (#360)

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](pallets/jinja@3.1.3...3.1.4)

---
updated-dependencies:
- dependency-name: jinja2
  dependency-type: indirect
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* Update RTD config to use Python 3.10 and rocm-docs-core 1.1.1 (#359)

* Add doc team as codeowner for RTD yaml config

* Update RTD config to use Python 3.10 and rocm-docs-core 1.1.1

* Bump rocm-docs-core[api_reference] from 1.1.1 to 1.2.0 in /docs/sphinx (#363)

Bumps [rocm-docs-core[api_reference]](https://github.com/RadeonOpenCompute/rocm-docs-core) from 1.1.1 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](ROCm/rocm-docs-core@v1.1.1...v1.2.0)

---
updated-dependencies:
- dependency-name: rocm-docs-core[api_reference]
  dependency-type: direct:production
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* Bump rocm-docs-core[api_reference] from 1.2.0 to 1.4.0 in /docs/sphinx (#369)

Bumps [rocm-docs-core[api_reference]](https://github.com/ROCm/rocm-docs-core) from 1.2.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](ROCm/rocm-docs-core@v1.2.0...v1.4.0)

---
updated-dependencies:
- dependency-name: rocm-docs-core[api_reference]
  dependency-type: direct:production
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* Bump urllib3 from 2.2.1 to 2.2.2 in /docs/sphinx (#371)

Bumps [urllib3](https://github.com/urllib3/urllib3) from 2.2.1 to 2.2.2.
- [Release notes](https://github.com/urllib3/urllib3/releases)
- [Changelog](https://github.com/urllib3/urllib3/blob/main/CHANGES.rst)
- [Commits](urllib3/urllib3@2.2.1...2.2.2)

---
updated-dependencies:
- dependency-name: urllib3
  dependency-type: indirect
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

---------

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: Sam Wu <22262939+samjwu@users.noreply.github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
  • Loading branch information
@SwRaw @samjwu @dependabot
3 people authored Jun 28, 2024
1 parent b36fb4d commit 1875530
Show file tree
Hide file tree
Showing 8 changed files with 75 additions and 72 deletions.
1 change: 1 addition & 0 deletions .github/CODEOWNERS
View file
Validating CODEOWNERS rules …
Original file line number Diff line number Diff line change
Expand Up @@ -3,3 +3,4 @@
docs/* @ROCm/rocm-documentation
*.md @ROCm/rocm-documentation
*.rst @ROCm/rocm-documentation
.readthedocs.yaml @ROCm/rocm-documentation
2 changes: 1 addition & 1 deletion .readthedocs.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,6 @@ python:
build:
os: ubuntu-22.04
tools:
python: "3.8"
python: "3.10"
apt_packages:
- "doxygen"
0 docs/data-type-support.rst → docs/api-reference/data-type-support.rst
View file
File renamed without changes.
10 changes: 7 additions & 3 deletions docs/index.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,13 +9,17 @@
hipCUB documentation
===========================

Welcome to the hipCUB docs home page! To learn more, see :ref:`what-is-hipcub`.
hipCUB is a thin header-only wrapper library on top of rocPRIM or CUB. It enables developers to port project
using CUB library to the `HIP <https://github.com/ROCm-Developer-Tools/HIP>`_ layer and to run them
on AMD hardware. To learn more, see :ref:`what-is-hipcub`

Our documentation is structured as follows:
You can access hipCUB code on our `GitHub repository <https://github.com/ROCm/hipCUB>`_.

The documentation is structured as follows:

.. grid:: 2

.. grid-item-card:: Reference
.. grid-item-card:: API Reference

* :ref:`data-type-support`
* :doc:`API library <../doxygen/html/index>`
Expand Down
4 changes: 2 additions & 2 deletions docs/sphinx/_toc.yml.in
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,9 @@ root: index
subtrees:
- entries:
- file: what-is-hipcub
- caption: Reference
- caption: API reference
entries:
- file: data-type-support
- file: api-reference/data-type-support
- file: doxygen/html/index
title: API library
- caption: About
Expand Down
2 changes: 1 addition & 1 deletion docs/sphinx/requirements.in
View file
Original file line number Diff line number Diff line change
@@ -1 +1 @@
rocm-docs-core[api_reference]==0.38.1
rocm-docs-core[api_reference]==1.4.0
126 changes: 62 additions & 64 deletions docs/sphinx/requirements.txt
View file
Original file line number Diff line number Diff line change
@@ -1,113 +1,109 @@
#
# This file is autogenerated by pip-compile with Python 3.8
# This file is autogenerated by pip-compile with Python 3.10
# by the following command:
#
# pip-compile requirements.in
#
accessible-pygments==0.0.3
accessible-pygments==0.0.4
# via pydata-sphinx-theme
alabaster==0.7.13
alabaster==0.7.16
# via sphinx
babel==2.12.1
babel==2.14.0
# via
# pydata-sphinx-theme
# sphinx
beautifulsoup4==4.11.2
beautifulsoup4==4.12.3
# via pydata-sphinx-theme
breathe==4.34.0
breathe==4.35.0
# via rocm-docs-core
certifi==2023.7.22
certifi==2024.2.2
# via requests
cffi==1.15.1
cffi==1.16.0
# via
# cryptography
# pynacl
charset-normalizer==3.1.0
charset-normalizer==3.3.2
# via requests
click==8.1.3
click==8.1.7
# via
# click-log
# doxysphinx
# sphinx-external-toc
click-log==0.4.0
# via doxysphinx
cryptography==42.0.4
cryptography==42.0.5
# via pyjwt
deprecated==1.2.13
deprecated==1.2.14
# via pygithub
docutils==0.16
docutils==0.21.2
# via
# breathe
# myst-parser
# pydata-sphinx-theme
# sphinx
doxysphinx==3.3.3
doxysphinx==3.3.8
# via rocm-docs-core
fastjsonschema==2.16.3
fastjsonschema==2.19.1
# via rocm-docs-core
gitdb==4.0.10
gitdb==4.0.11
# via gitpython
gitpython==3.1.41
gitpython==3.1.43
# via rocm-docs-core
idna==3.4
idna==3.7
# via requests
imagesize==1.4.1
# via sphinx
importlib-metadata==6.8.0
# via sphinx
importlib-resources==6.1.0
# via rocm-docs-core
jinja2==3.1.3
jinja2==3.1.4
# via
# myst-parser
# sphinx
libsass==0.22.0
# via doxysphinx
lxml==4.9.2
lxml==4.9.4
# via doxysphinx
markdown-it-py==2.2.0
markdown-it-py==3.0.0
# via
# mdit-py-plugins
# myst-parser
markupsafe==2.1.2
markupsafe==2.1.5
# via jinja2
mdit-py-plugins==0.3.5
mdit-py-plugins==0.4.0
# via myst-parser
mdurl==0.1.2
# via markdown-it-py
mpire==2.7.1
mpire==2.10.1
# via doxysphinx
myst-parser==1.0.0
myst-parser==3.0.1
# via rocm-docs-core
packaging==23.0
numpy==1.26.4
# via doxysphinx
packaging==24.0
# via
# pydata-sphinx-theme
# sphinx
pycparser==2.21
pycparser==2.22
# via cffi
pydata-sphinx-theme==0.13.3
pydata-sphinx-theme==0.15.2
# via
# rocm-docs-core
# sphinx-book-theme
pygithub==1.58.2
pygithub==2.3.0
# via rocm-docs-core
pygments==2.15.0
pygments==2.17.2
# via
# accessible-pygments
# mpire
# pydata-sphinx-theme
# sphinx
pyjson5==1.6.2
pyjson5==1.6.6
# via doxysphinx
pyjwt[crypto]==2.6.0
pyjwt[crypto]==2.8.0
# via pygithub
pynacl==1.5.0
# via pygithub
pyparsing==3.0.9
pyparsing==3.1.2
# via doxysphinx
pytz==2023.3.post1
# via babel
pyyaml==6.0
pyyaml==6.0.1
# via
# myst-parser
# rocm-docs-core
Expand All @@ -116,15 +112,15 @@ requests==2.31.0
# via
# pygithub
# sphinx
rocm-docs-core[api-reference]==0.38.1
rocm-docs-core[api-reference]==1.4.0
# via -r requirements.in
smmap==5.0.0
smmap==5.0.1
# via gitdb
snowballstemmer==2.2.0
# via sphinx
soupsieve==2.4
soupsieve==2.5
# via beautifulsoup4
sphinx==5.3.0
sphinx==7.3.7
# via
# breathe
# myst-parser
Expand All @@ -135,37 +131,39 @@ sphinx==5.3.0
# sphinx-design
# sphinx-external-toc
# sphinx-notfound-page
sphinx-book-theme==1.0.1
sphinx-book-theme==1.1.2
# via rocm-docs-core
sphinx-copybutton==0.5.1
sphinx-copybutton==0.5.2
# via rocm-docs-core
sphinx-design==0.3.0
sphinx-design==0.5.0
# via rocm-docs-core
sphinx-external-toc==0.3.1
sphinx-external-toc==1.0.1
# via rocm-docs-core
sphinx-notfound-page==0.8.3
sphinx-notfound-page==1.0.0
# via rocm-docs-core
sphinxcontrib-applehelp==1.0.4
sphinxcontrib-applehelp==1.0.8
# via sphinx
sphinxcontrib-devhelp==1.0.2
sphinxcontrib-devhelp==1.0.6
# via sphinx
sphinxcontrib-htmlhelp==2.0.1
sphinxcontrib-htmlhelp==2.0.5
# via sphinx
sphinxcontrib-jsmath==1.0.1
# via sphinx
sphinxcontrib-qthelp==1.0.3
sphinxcontrib-qthelp==1.0.7
# via sphinx
sphinxcontrib-serializinghtml==1.1.5
sphinxcontrib-serializinghtml==1.1.10
# via sphinx
tqdm==4.65.0
tomli==2.0.1
# via sphinx
tqdm==4.66.4
# via mpire
typing-extensions==4.5.0
# via pydata-sphinx-theme
urllib3==1.26.18
# via requests
wrapt==1.15.0
# via deprecated
zipp==3.17.0
typing-extensions==4.11.0
# via
# pydata-sphinx-theme
# pygithub
urllib3==2.2.2
# via
# importlib-metadata
# importlib-resources
# pygithub
# requests
wrapt==1.16.0
# via deprecated
2 changes: 1 addition & 1 deletion docs/what-is-hipcub.rst
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
.. meta::
:description: hipCUB is a thin header-only wrapper library on top of rocPRIM or CUB that enables developers to port project
using CUB library to the HIP layer.
using CUB library to the HIP layer.
:keywords: hipCUB, ROCm, library, API

.. _what-is-hipcub:
Expand Down

0 comments on commit 1875530

Please sign in to comment.