ac1fa8dccb
[SWDEV-567284] AMDSMI conceptual documentation for setting perf determinism ( #2529 )
...
Authored-by: Koushik Billakanti <kbillaka@amd.com >
2026-01-08 08:04:23 -06:00
16f06808d4
[SWDEV-565460] AMD SMI Document Multiple Init Best Practices ( #2293 )
...
* [SWDEV-565460] AMD SMI Document Multiple Init Best Practices
Signed-off-by: amd-josnarlo <josnarlo.amd.com>
* Add sphinxcontrib-mermaid to render diagram in HTML
bump rocm-docs-core to 1.31.0
pip-compile requirements.txt
---------
Signed-off-by: amd-josnarlo <josnarlo.amd.com>
Co-authored-by: amd-josnarlo <josnarlo.amd.com>
Co-authored-by: Peter Park <peter.park@amd.com >
2025-12-16 11:06:18 -06:00
f36affe4d5
Bump rocm-docs-core[api_reference] from 1.26.0 to 1.27.0 in /docs/sphinx ( #790 )
...
Bumps [rocm-docs-core[api_reference]](https://github.com/ROCm/rocm-docs-core ) from 1.26.0 to 1.27.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.26.0...v1.27.0 )
---
updated-dependencies:
- dependency-name: rocm-docs-core[api_reference]
dependency-version: 1.27.0
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>
[ROCm/amdsmi commit: 6f222c11a6
2025-10-28 09:59:49 -05:00
8104a48f8e
Bump rocm-docs-core[api_reference] from 1.25.0 to 1.26.0 in /docs/sphinx
...
Bumps [rocm-docs-core[api_reference]](https://github.com/ROCm/rocm-docs-core ) from 1.25.0 to 1.26.0.
- [Release notes](https://github.com/ROCm/rocm-docs-core/releases )
- [Changelog](https://github.com/ROCm/rocm-docs-core/blob/v1.26.0/CHANGELOG.md )
- [Commits](https://github.com/ROCm/rocm-docs-core/compare/v1.25.0...v1.26.0 )
---
updated-dependencies:
- dependency-name: rocm-docs-core[api_reference]
dependency-version: 1.26.0
dependency-type: direct:production
update-type: version-update:semver-minor
...
Signed-off-by: dependabot[bot] <support@github.com >
[ROCm/amdsmi commit: faf0024135
2025-10-06 09:17:33 -05:00
83bbbd55a3
docs: Update Doxygen, Sphinx, and readthedocs configs ( #719 )
...
* conf: update RTD config to ub24.04 (doxygen 1.9.8) and py3.12
* update generate-docs workflow
* Update "modules" to "topics" due to Doxygen 1.9.8
* bump rocm-docs-core to 1.25.0 and pip-compile requirements.txt
* doxygen: fill in version string in Doxyfile from conf.py
* remove unneeded rocm-smi-lib tutorials
* remove wikipedia references in doxyfile to satisfy ci check
Signed-off-by: Park, Peter <Peter.Park@amd.com >
[ROCm/amdsmi commit: 311eade5b1
2025-09-26 17:30:48 -05:00
0f75c19e4d
[SWDEV-551318] Add doc about RAS / CPER ( #636 )
...
* add doc about ras/cper
* add sample code examples for CPER and AFID
---------
Signed-off-by: Park, Peter <Peter.Park@amd.com >
Signed-off-by: Arif, Maisam <Maisam.Arif@amd.com >
Co-authored-by: Oosman Saeed <oossaeed@amd.com >
[ROCm/amdsmi commit: 5e92adc5b3
2025-09-09 10:27:15 -05:00
dbe45d5ea2
Bump urllib3 from 2.3.0 to 2.5.0 in /docs/sphinx ( #546 )
...
Bumps [urllib3](https://github.com/urllib3/urllib3 ) from 2.3.0 to 2.5.0.
- [Release notes](https://github.com/urllib3/urllib3/releases )
- [Changelog](https://github.com/urllib3/urllib3/blob/main/CHANGES.rst )
- [Commits](https://github.com/urllib3/urllib3/compare/2.3.0...2.5.0 )
---
updated-dependencies:
- dependency-name: urllib3
dependency-version: 2.5.0
dependency-type: indirect
...
Signed-off-by: dependabot[bot] <support@github.com >
[ROCm/amdsmi commit: 28e577f1c0
2025-07-13 11:43:30 -05:00
aecda316c4
Fix links in docs ( #532 )
...
* fix links in amdsmi_cli/README.md
* fix xrefs to install docs
* rm rocm-smi examples and add cli tutorial
* rm disclaimer and add amd smi contributing guidelines to index
Signed-off-by: Peter Park <Peter.Park@amd.com >
[ROCm/amdsmi commit: 8039ab9449
2025-07-07 11:18:40 -05:00
b1753ad3b3
Bump rocm-docs-core[api_reference] from 1.17.0 to 1.20.1 in /docs/sphinx
...
Bumps [rocm-docs-core[api_reference]](https://github.com/ROCm/rocm-docs-core ) from 1.17.0 to 1.20.1.
- [Release notes](https://github.com/ROCm/rocm-docs-core/releases )
- [Changelog](https://github.com/ROCm/rocm-docs-core/blob/v1.20.1/CHANGELOG.md )
- [Commits](https://github.com/ROCm/rocm-docs-core/compare/v1.17.0...v1.20.1 )
---
updated-dependencies:
- dependency-name: rocm-docs-core[api_reference]
dependency-version: 1.20.1
dependency-type: direct:production
update-type: version-update:semver-minor
...
Signed-off-by: dependabot[bot] <support@github.com >
[ROCm/amdsmi commit: 152184dd49
2025-06-13 16:35:08 -05:00
aa35398722
Bump requests from 2.32.3 to 2.32.4 in /docs/sphinx ( #471 )
...
Bumps [requests](https://github.com/psf/requests ) from 2.32.3 to 2.32.4.
- [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.32.3...v2.32.4 )
---
updated-dependencies:
- dependency-name: requests
dependency-version: 2.32.4
dependency-type: indirect
...
Signed-off-by: dependabot[bot] <support@github.com >
[ROCm/amdsmi commit: 7e956ce4f3
2025-06-11 08:23:27 -05:00
2f803473e1
Bump tornado from 6.4.2 to 6.5.1 in /docs/sphinx ( #418 )
...
Bumps [tornado](https://github.com/tornadoweb/tornado ) from 6.4.2 to 6.5.1.
- [Changelog](https://github.com/tornadoweb/tornado/blob/master/docs/releases.rst )
- [Commits](https://github.com/tornadoweb/tornado/compare/v6.4.2...v6.5.1 )
---
updated-dependencies:
- dependency-name: tornado
dependency-version: 6.5.1
dependency-type: indirect
...
[ROCm/amdsmi commit: dd81cfd688
2025-05-30 19:53:58 -05:00
a0ce11135d
Bump jinja2 from 3.1.5 to 3.1.6 in /docs/sphinx
...
Bumps [jinja2](https://github.com/pallets/jinja ) from 3.1.5 to 3.1.6.
- [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.5...3.1.6 )
---
updated-dependencies:
- dependency-name: jinja2
dependency-version: 3.1.6
dependency-type: indirect
...
Signed-off-by: dependabot[bot] <support@github.com >
[ROCm/amdsmi commit: 581ad75729
2025-04-16 15:08:41 -05:00
3dbeab2c67
[SWDEV-519170] Docker container config documentation ( #178 )
...
* add docker container guide
* add example
* update index, README, and _toc
[ROCm/amdsmi commit: 547ed49efb
2025-03-14 09:58:46 -05:00
54eba4b8a8
[SWDEV-510820] Add missing goamdsmi documentation ( #147 )
...
* add API doc comments to goamdsmi.go
* update README and usage
* add sphinx directive to parse go doc
* fix walrus operator typos
* make docs more consistent
* add Go docs to index.md
---------
Signed-off-by: Arif, Maisam <Maisam.Arif@amd.com >
[ROCm/amdsmi commit: 15c32f6116
2025-03-07 12:37:54 -06:00
3804af1c7a
Bump rocm-docs-core to 1.17.0 ( #145 )
...
* Bump rocm-docs-core to 1.17.0
* Fix link to ROCm multi-version install
---------
Signed-off-by: Park, Peter <Peter.Park@amd.com >
[ROCm/amdsmi commit: adc86d0858
2025-03-04 09:34:18 -06:00
b7157d0d13
Bump jinja2 from 3.1.4 to 3.1.5 in /docs/sphinx ( #136 )
...
Bumps [jinja2](https://github.com/pallets/jinja ) from 3.1.4 to 3.1.5.
- [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.4...3.1.5 )
---
updated-dependencies:
- dependency-name: jinja2
dependency-type: indirect
...
Signed-off-by: dependabot[bot] <support@github.com >
Signed-off-by: Arif, Maisam <Maisam.Arif@amd.com >
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: Arif, Maisam <Maisam.Arif@amd.com >
[ROCm/amdsmi commit: b4c05ccb16
2025-02-26 14:55:45 -06:00
f08502aa72
Bump cryptography from 43.0.1 to 44.0.1 in /docs/sphinx ( #137 )
...
Bumps [cryptography](https://github.com/pyca/cryptography ) from 43.0.1 to 44.0.1.
- [Changelog](https://github.com/pyca/cryptography/blob/main/CHANGELOG.rst )
- [Commits](https://github.com/pyca/cryptography/compare/43.0.1...44.0.1 )
---
updated-dependencies:
- dependency-name: cryptography
dependency-type: indirect
...
Signed-off-by: dependabot[bot] <support@github.com >
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
[ROCm/amdsmi commit: c05e4ff2e7
2025-02-26 14:54:48 -06:00
a003e50130
docs: Remove redundant/stale docs
...
bump rocm-docs-core to 1.8.2
rm unused files
rm stale docs
fix sphinx conf
reorg docs
SWDEV-482203 -- add note to usage guides
update readmes
Change-Id: I9e0111ac8fe2a691ac964b27436ba47747c27904
Signed-off-by: Peter Park <Peter.Park@amd.com >
[ROCm/amdsmi commit: e196f98dba
2024-11-11 16:49:17 -04:00
4799537b20
Docs - Switch to amd-staging branch
...
Change-Id: I1a26542b3a7831c1f5efea6d6b4084f77b0a7cdb
Signed-off-by: Galantsev, Dmitrii <dmitrii.galantsev@amd.com >
[ROCm/amdsmi commit: f3426ced06
2024-07-23 17:10:34 -05:00
1323df0c6e
[ROCDOC-593] Update Read the Docs documentation requirements
...
Change-Id: I48350a42a50f0e85d9f074295e27c20b4b66cdb4
[ROCm/amdsmi commit: 94cab382bf
2024-06-17 16:54:59 -04:00
584e10f58b
Amdsmidocs reorg
...
Change-Id: I836fc341d2a3567f531ba753463e57cd4b9b6495
Signed-off-by: Galantsev, Dmitrii <dmitrii.galantsev@amd.com >
[ROCm/amdsmi commit: af225a6deb
2024-05-15 04:26:41 -04:00
e8917791e8
Update RTD config to use Python 3.10 and rocm-docs-core 1.1.1
...
Change-Id: Icfd12dd44e8779dbf95a1f1e9277f9227ff816f6
[ROCm/amdsmi commit: a37b0a3ffe
2024-05-05 23:59:13 -04:00
e7814472bf
Updated Sphinx to include Changelog
...
Signed-off-by: Maisam Arif <maisarif@amd.com >
Change-Id: I858d0579ab0e8ba9f228373b6d31dfd3088703ae
[ROCm/amdsmi commit: e81051a724
2024-04-23 04:48:42 -05:00
5b6d22b24e
SWDEV-425457 - Updated Sphinx docs to include ESMI
...
Signed-off-by: Maisam Arif <maisarif@amd.com >
Change-Id: Ie7669c9f94703e5c5cdc65314cbf30e8b587d0f1
[ROCm/amdsmi commit: f061aa4be5
2023-11-02 17:39:56 -04:00
f340c5ca5b
update documentation requirements and dependabot configuration
...
Change-Id: I652872286c5975d770abb97513469f4527807d7f
[ROCm/amdsmi commit: 18ef862886
2023-08-14 13:13:57 -06:00
b634f8420b
Changed RPM dependencies to suggestions
...
Change-Id: I3d2918cc1f86733aaee41f86e1619bd22316398b
Signed-off-by: Maisam Arif <Maisam.Arif@amd.com >
[ROCm/amdsmi commit: b6d7570bd4
2023-06-22 11:44:28 -05:00
602130e212
Sphinx Documentation Setup
...
Added README links to Python library and CLI tool
Get correct version number from header file
Updated base README with sphinx documentation steps
Change-Id: I60eb3d37d77dab4ff7c8334f94b9c1804edb524b
Signed-off-by: Maisam Arif <Maisam.Arif@amd.com >
[ROCm/amdsmi commit: 7104b6fe31
2023-06-07 09:47:37 -05:00
505a8bc3c4
add configurations for sphinx documentation
...
Change-Id: I5672348aab0f20d0bfc4dd1efcfecdf4324342d6
[ROCm/amdsmi commit: c5e06b4040
2023-05-30 16:08:54 -06:00
koushikbillakanti-amd
Joseph Narlo
dependabot[bot]
Park, Peter
Galantsev, Dmitrii
Sam Wu
Roopa Malavally
Sam Wu
Maisam Arif
Maisam Arif