Skip to content

Update documentation format #19

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
peterjunpark wants to merge 3 commits into
base: staging
Choose a base branch
from
Open

Update documentation format #19

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
9a1de63
chore: bump rocm-docs-core to 1.32.0
peterjunpark Feb 24, 2026
7bf9ed8
gitignore documentation build stuff
peterjunpark Feb 24, 2026
810e925
update conf
peterjunpark Feb 25, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions smi-lib/.gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,3 +3,7 @@ dl/*
msgpuv/build/wNow64a/B_*
msgpuv/build/wNxt64a/B_*
.venv/*

# doc artifacts
_build
_doxygen
12 changes: 5 additions & 7 deletions smi-lib/docs/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@

#
# Copyright (c) 2025 Advanced Micro Devices, Inc. All rights reserved.
# Copyright (c) Advanced Micro Devices, Inc. All rights reserved.
#
# Permission is hereby granted, free of charge, to any person obtaining a copy
# of this software and associated documentation files (the "Software"), to deal
Expand Down Expand Up @@ -31,8 +31,6 @@
if os.environ.get("READTHEDOCS", "") == "True":
html_context["READTHEDOCS"] = True

sys.path.append(str(Path('_extension').resolve()))

def get_version_info(filepath):
version_major = None
version_minor = None
Expand All @@ -58,9 +56,9 @@ def get_version_info(filepath):
version_number = "{}.{}.{}".format(version_major, version_minor, version_release)

# project info
project = "AMD SMI"
project = "AMD SMI (virtualization)"
author = "Advanced Micro Devices, Inc."
copyright = "Copyright (c) 2025 Advanced Micro Devices, Inc. All rights reserved."
copyright = "Copyright (c) %Y Advanced Micro Devices, Inc. All rights reserved."
version = version_number
release = version_number

Expand All @@ -70,7 +68,7 @@ def get_version_info(filepath):
"repository_provider": "github",
"repository_url": "https://github.com/amd/MxGPU-Virtualization",
"link_main_doc": True,
"announcement": "This page documents AMD-SMI for virtualization hosts only. Please see the standard <a href='https://rocm.docs.amd.com/projects/amdsmi/en/latest/'>AMD-SMI</a> site for all other uses.",
"announcement": "This page documents AMD SMI for virtualization hosts only. See the <a href='https://rocm.docs.amd.com/projects/amdsmi/en/latest/'>AMD SMI</a> site for all other uses.",
"nav_secondary_items": {
"Community": "https://github.com/ROCm/ROCm/discussions",
"Blogs": "https://rocm.blogs.amd.com/",
Expand All @@ -83,7 +81,7 @@ def get_version_info(filepath):
suppress_warnings = ["etoc.toctree"]
external_toc_path = "./sphinx/_toc.yml"

external_projects_current_project = "amdsmi"
external_projects_current_project = "amdsmi-virt"
extensions = ["rocm_docs", "rocm_docs.doxygen"]

doxygen_root = "doxygen"
Expand Down
32 changes: 3 additions & 29 deletions smi-lib/docs/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,11 @@ myst:
"keywords": "amdsmi, lib, cli, system, management, interface, admin, sys"
---

# AMD SMI documentation
# AMD SMI (virtualization) documentation

AMD SMI LIB is a library that enables you to manage and monitor AMD Virtualization Enabled GPUs. It is a thread safe, extensible C based library. The library exposes both C and Python API interface.
AMD SMI is a library that enables you to manage and monitor AMD virtualization-enabled GPUs. It is a thread safe, extensible C-based library. The library exposes both C and Python API interfaces.

```{note}
```{important}
This is the AMD SMI for SR-IOV Linux host only. If you are looking for Linux baremetal or SR-IOV Linux guest AMD SMI, please go to the [AMD SMI documentation](https://rocm.docs.amd.com/projects/amdsmi/en/latest/index.html).
```

Expand Down Expand Up @@ -81,29 +81,3 @@ For additional information on build, installation, usage, versioning and API ref
:::

::::

<style>
#disclaimer {
font-size: 0.8rem;
}
</style>

<div id="disclaimer">
The information contained herein is for informational purposes only, and is
subject to change without notice. While every precaution has been taken in the
preparation of this document, it may contain technical inaccuracies, omissions
and typographical errors, and AMD is under no obligation to update or otherwise
correct this information. Advanced Micro Devices, Inc. makes no representations
or warranties with respect to the accuracy or completeness of the contents of
this document, and assumes no liability of any kind, including the implied
warranties of noninfringement, merchantability or fitness for particular
purposes, with respect to the operation or use of AMD hardware, software or
other products described herein.

AMD, the AMD Arrow logo, and combinations thereof are trademarks of Advanced
Micro Devices, Inc. Other product names used in this publication are for
identification purposes only and may be trademarks of their respective
companies.

Copyright &copy; 2025 Advanced Micro Devices, Inc. All rights reserved.
</div>
2 changes: 1 addition & 1 deletion smi-lib/docs/sphinx/requirements.in
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1 @@
rocm-docs-core[api_reference]==1.17.0
rocm-docs-core[api_reference]==1.32.0
Loading