12 Коммитов

Автор SHA1 Сообщение Дата
Joseph Narlo 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
Park, Peter 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
Park, Peter 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
Narlo, Joseph a097bb5fe2 [SWDEV-515031] Change Header Version to 25.2.0 (#109)
Change Versioning Scheme to match https://semver.org/
Dropping the year enum and API fields in a future release.
Should not impact library versioning since we are now starting from 25.2.0
---------

Signed-off-by: Joseph Narlo <joseph.narlo@amd.com>
Co-authored-by: Arif, Maisam <Maisam.Arif@amd.com>
Change-Id: Id090e23f156926d08f9c0b781447388adf268cf6


[ROCm/amdsmi commit: d7c3ad0886]
2025-02-26 19:17:09 -06:00
Park, Peter 35b58c8fb4 Update copyright year to 2025
Signed-off-by: Peter Park <peter.park@amd.com>

[ROCm/amdsmi commit: 63af5cf611]
2025-01-22 15:06:09 -06:00
Peter Park 49592ef24f remove duplicated changelog
black format docs/conf.py
add seealso to python api reference

Change-Id: I60fa754f0af662669282dc90eea4b7dc5c5030cc
Signed-off-by: Peter Park <peter.park@amd.com>


[ROCm/amdsmi commit: cbfe403b1d]
2024-11-13 11:46:47 -05:00
Peter Park 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
Maisam Arif 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
Galantsev, Dmitrii 1128c1f246 DOCS - Fix 'failed to reach any of the inventories'
Change-Id: I7edd1fad17bd0f3e0946a6712410cf6549afc729
Signed-off-by: Galantsev, Dmitrii <dmitrii.galantsev@amd.com>


[ROCm/amdsmi commit: fc02ebc5f2]
2023-11-03 03:59:48 -04:00
Maisam Arif 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
Sam Wu 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
Sam Wu 505a8bc3c4 add configurations for sphinx documentation
Change-Id: I5672348aab0f20d0bfc4dd1efcfecdf4324342d6


[ROCm/amdsmi commit: c5e06b4040]
2023-05-30 16:08:54 -06:00