Park, Peter
15c32f6116
* 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>
56 行
1.4 KiB
Plaintext
56 行
1.4 KiB
Plaintext
defaults:
|
|
numbered: false
|
|
root: index
|
|
subtrees:
|
|
- caption: Install
|
|
entries:
|
|
- file: install/install.md
|
|
title: Library and CLI tool installation
|
|
- file: install/build.md
|
|
title: Build from source
|
|
|
|
- caption: How to
|
|
entries:
|
|
- file: how-to/amdsmi-cpp-lib.md
|
|
title: C++ library usage
|
|
- file: how-to/amdsmi-py-lib.md
|
|
title: Python library usage
|
|
- file: how-to/amdsmi-go-lib.md
|
|
title: Go library usage
|
|
- file: how-to/amdsmi-cli-tool.md
|
|
title: CLI tool usage
|
|
|
|
- caption: Reference
|
|
entries:
|
|
- file: reference/amdsmi-cpp-api.md
|
|
title: C++ API
|
|
entries:
|
|
- file: doxygen/docBin/html/modules
|
|
title: Modules
|
|
- file: doxygen/docBin/html/files
|
|
title: Files
|
|
- file: doxygen/docBin/html/globals
|
|
title: Globals
|
|
- file: doxygen/docBin/html/annotated
|
|
title: Data structures
|
|
- file: doxygen/docBin/html/functions_data_fields
|
|
title: Data fields
|
|
- file: reference/amdsmi-py-api.md
|
|
title: Python API
|
|
- file: reference/amdsmi-go-api.md
|
|
title: Go API
|
|
- file: reference/changelog.md
|
|
title: Changelog
|
|
|
|
- caption: Tutorials
|
|
entries:
|
|
- url: https://github.com/ROCm/amdsmi/tree/amd-staging/example
|
|
title: AMD SMI examples (GitHub)
|
|
- url: https://github.com/ROCm/rocm_smi_lib/tree/amd-staging/example
|
|
title: ROCm SMI lib examples (GitHub)
|
|
|
|
- caption: About
|
|
entries:
|
|
- file: license.md
|
|
|