SWDEV-490062 - Update documentation

Change-Id: Ib5297fdda2e05795b3b20436cc1de962e310b08b


[ROCm/hip commit: 3d60bd3a64]
This commit is contained in:
Istvan Kiss
2024-10-21 16:50:09 +02:00
committed by Istvan Kiss
parent 862e713a5c
commit 122cecc59d
108 changed files with 14036 additions and 2987 deletions
+64 -6
View File
@@ -16,9 +16,10 @@ subtrees:
- caption: Conceptual
entries:
- file: understand/programming_model
- file: understand/programming_model_reference
- file: understand/hardware_implementation
- file: understand/amd_clr
- file: understand/texture_fetching
title: Texture fetching
- caption: How to
entries:
@@ -29,16 +30,68 @@ subtrees:
- file: how-to/performance_guidelines
- file: how-to/debugging
- file: how-to/logging
- file: how-to/cooperative_groups
- file: how-to/unified_memory
title: Unified memory
- file: how-to/virtual_memory
title: Virtual memory
- file: how-to/stream_ordered_allocator
- file: how-to/hipgraph
title: HIP graphs
- file: how-to/faq
- caption: Reference
entries:
- file: doxygen/html/index
- file: reference/kernel_language
title: C++ language extensions
- file: reference/terms
title: Comparing Syntax for different APIs
- file: reference/hip_runtime_api_reference
subtrees:
- entries:
- file: reference/hip_runtime_api/modules
subtrees:
- entries:
- file: reference/hip_runtime_api/modules/initialization_and_version
- file: reference/hip_runtime_api/modules/device_management
- file: reference/hip_runtime_api/modules/execution_control
- file: reference/hip_runtime_api/modules/error_handling
- file: reference/hip_runtime_api/modules/stream_management
- file: reference/hip_runtime_api/modules/stream_memory_operations
- file: reference/hip_runtime_api/modules/event_management
- file: reference/hip_runtime_api/modules/memory_management
subtrees:
- entries:
- file: reference/hip_runtime_api/modules/memory_management/memory_management_deprecated
- file: reference/hip_runtime_api/modules/memory_management/external_resource_interoperability
- file: reference/hip_runtime_api/modules/memory_management/stream_ordered_memory_allocator
- file: reference/hip_runtime_api/modules/memory_management/unified_memory_reference
- file: reference/hip_runtime_api/modules/memory_management/virtual_memory_reference
- file: reference/hip_runtime_api/modules/memory_management/texture_management
- file: reference/hip_runtime_api/modules/memory_management/texture_management_deprecated
- file: reference/hip_runtime_api/modules/memory_management/surface_object
- file: reference/hip_runtime_api/modules/peer_to_peer_device_memory_access
- file: reference/hip_runtime_api/modules/context_management
- file: reference/hip_runtime_api/modules/module_management
- file: reference/hip_runtime_api/modules/occupancy
- file: reference/hip_runtime_api/modules/profiler_control
- file: reference/hip_runtime_api/modules/launch_api
- file: reference/hip_runtime_api/modules/runtime_compilation
- file: reference/hip_runtime_api/modules/callback_activity_apis
- file: reference/hip_runtime_api/modules/graph_management
- file: reference/hip_runtime_api/modules/opengl_interoperability
- file: reference/hip_runtime_api/modules/cooperative_groups_reference
- file: reference/hip_runtime_api/global_defines_enums_structs_files
subtrees:
- entries:
- file: reference/hip_runtime_api/global_defines_enums_structs_files/global_enum_and_defines
- file: reference/hip_runtime_api/global_defines_enums_structs_files/driver_types
- file: doxygen/html/annotated
- file: doxygen/html/files
- file: reference/virtual_rocr
- file: reference/cpp_language_extensions
title: C++ language extensions
- file: reference/cpp_language_support
title: C++ language support
- file: reference/math_api
- file: reference/terms
title: Comparing syntax for different APIs
- file: reference/deprecated_api_list
title: List of deprecated APIs
- file: reference/fp8_numbers
@@ -46,10 +99,15 @@ subtrees:
- caption: Tutorials
entries:
- url: https://github.com/ROCm/rocm-examples/tree/develop/HIP-Basic
title: HIP basic examples
- url: https://github.com/ROCm/HIP-Examples
title: HIP examples
- url: https://github.com/ROCm/hip-tests/tree/develop/samples
title: HIP test samples
- file: tutorial/saxpy
- file: tutorial/reduction
- file: tutorial/cooperative_groups_tutorial
- caption: About
entries:
+1 -1
View File
@@ -1,2 +1,2 @@
rocm-docs-core[api_reference]==1.1.1
rocm-docs-core[api_reference]==1.7.2
sphinxcontrib.doxylink
+37 -35
View File
@@ -4,11 +4,11 @@
#
# pip-compile requirements.in
#
accessible-pygments==0.0.4
accessible-pygments==0.0.5
# via pydata-sphinx-theme
alabaster==0.7.16
alabaster==1.0.0
# via sphinx
babel==2.14.0
babel==2.16.0
# via
# pydata-sphinx-theme
# sphinx
@@ -16,9 +16,9 @@ beautifulsoup4==4.12.3
# via pydata-sphinx-theme
breathe==4.35.0
# via rocm-docs-core
certifi==2024.2.2
certifi==2024.8.30
# via requests
cffi==1.16.0
cffi==1.17.1
# via
# cryptography
# pynacl
@@ -31,7 +31,7 @@ click==8.1.7
# sphinx-external-toc
click-log==0.4.0
# via doxysphinx
cryptography==42.0.5
cryptography==43.0.1
# via pyjwt
deprecated==1.2.14
# via pygithub
@@ -41,19 +41,19 @@ docutils==0.21.2
# myst-parser
# pydata-sphinx-theme
# sphinx
doxysphinx==3.3.7
doxysphinx==3.3.10
# via rocm-docs-core
fastjsonschema==2.19.1
fastjsonschema==2.20.0
# via rocm-docs-core
gitdb==4.0.11
# via gitpython
gitpython==3.1.43
# via rocm-docs-core
idna==3.7
idna==3.8
# via requests
imagesize==1.4.1
# via sphinx
jinja2==3.1.3
jinja2==3.1.4
# via
# myst-parser
# sphinx
@@ -67,27 +67,29 @@ markdown-it-py==3.0.0
# myst-parser
markupsafe==2.1.5
# via jinja2
mdit-py-plugins==0.4.0
mdit-py-plugins==0.4.1
# via myst-parser
mdurl==0.1.2
# via markdown-it-py
mpire==2.10.1
mpire==2.10.2
# via doxysphinx
myst-parser==3.0.0
myst-parser==4.0.0
# via rocm-docs-core
packaging==24.0
numpy==1.26.4
# via doxysphinx
packaging==24.1
# via
# pydata-sphinx-theme
# sphinx
pycparser==2.22
# via cffi
pydata-sphinx-theme==0.15.2
pydata-sphinx-theme==0.15.4
# via
# rocm-docs-core
# sphinx-book-theme
pygithub==2.3.0
pygithub==2.4.0
# via rocm-docs-core
pygments==2.17.2
pygments==2.18.0
# via
# accessible-pygments
# mpire
@@ -95,26 +97,26 @@ pygments==2.17.2
# sphinx
pyjson5==1.6.6
# via doxysphinx
pyjwt[crypto]==2.8.0
pyjwt[crypto]==2.9.0
# via pygithub
pynacl==1.5.0
# via pygithub
pyparsing==3.1.2
pyparsing==3.1.4
# via
# doxysphinx
# sphinxcontrib-doxylink
python-dateutil==2.9.0.post0
# via sphinxcontrib-doxylink
pyyaml==6.0.1
pyyaml==6.0.2
# via
# myst-parser
# rocm-docs-core
# sphinx-external-toc
requests==2.31.0
requests==2.32.3
# via
# pygithub
# sphinx
rocm-docs-core[api-reference]==1.1.1
rocm-docs-core[api-reference]==1.7.2
# via -r requirements.in
six==1.16.0
# via python-dateutil
@@ -122,9 +124,9 @@ smmap==5.0.1
# via gitdb
snowballstemmer==2.2.0
# via sphinx
soupsieve==2.5
soupsieve==2.6
# via beautifulsoup4
sphinx==7.3.7
sphinx==8.0.2
# via
# breathe
# myst-parser
@@ -136,39 +138,39 @@ sphinx==7.3.7
# sphinx-external-toc
# sphinx-notfound-page
# sphinxcontrib-doxylink
sphinx-book-theme==1.1.2
sphinx-book-theme==1.1.3
# via rocm-docs-core
sphinx-copybutton==0.5.2
# via rocm-docs-core
sphinx-design==0.5.0
sphinx-design==0.6.1
# via rocm-docs-core
sphinx-external-toc==1.0.1
# via rocm-docs-core
sphinx-notfound-page==1.0.0
sphinx-notfound-page==1.0.4
# via rocm-docs-core
sphinxcontrib-applehelp==1.0.8
sphinxcontrib-applehelp==2.0.0
# via sphinx
sphinxcontrib-devhelp==1.0.6
sphinxcontrib-devhelp==2.0.0
# via sphinx
sphinxcontrib-doxylink==1.12.3
# via -r requirements.in
sphinxcontrib-htmlhelp==2.0.5
sphinxcontrib-htmlhelp==2.1.0
# via sphinx
sphinxcontrib-jsmath==1.0.1
# via sphinx
sphinxcontrib-qthelp==1.0.7
sphinxcontrib-qthelp==2.0.0
# via sphinx
sphinxcontrib-serializinghtml==1.1.10
sphinxcontrib-serializinghtml==2.0.0
# via sphinx
tomli==2.0.1
# via sphinx
tqdm==4.66.2
tqdm==4.66.5
# via mpire
typing-extensions==4.11.0
typing-extensions==4.12.2
# via
# pydata-sphinx-theme
# pygithub
urllib3==2.2.1
urllib3==2.2.2
# via
# pygithub
# requests