Update documentation format

smi-lib/.gitignore

@@ -3,3 +3,7 @@ dl/*
 msgpuv/build/wNow64a/B_*
 msgpuv/build/wNxt64a/B_*
 .venv/*
+
+# doc artifacts
+_build
+_doxygen

smi-lib/.readthedocs.yaml

@@ -4,15 +4,15 @@
 version: 2
 
 build:
-   os: ubuntu-22.04
-   tools:
-      python: "3.10"
+    os: ubuntu-24.04
+    tools:
+        python: "3.12"
 
 sphinx:
-   configuration: smi-lib/docs/conf.py
+    configuration: smi-lib/docs/conf.py
 
-formats: [htmlzip, pdf, epub]
+formats: [htmlzip, pdf]
 
 python:
-   install:
-   - requirements: smi-lib/docs/sphinx/requirements.txt
+    install:
+        - requirements: smi-lib/docs/sphinx/requirements.txt

smi-lib/docs/about/license.md

@@ -0,0 +1,11 @@
+---
+myst:
+  html_meta:
+    "description lang=en": "AMD SMI (virtualization) license agreement"
+    "keywords": "amdsmi, amd, smi, virt, virtualization, gpu, sriov, linux, host, license, legal, mit"
+---
+
+# License
+
+```{include} ../../LICENSE
+```

smi-lib/docs/conf.py

@@ -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
@@ -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
@@ -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 for 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
 
@@ -70,25 +68,25 @@ 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": {
+        "GitHub": "https://github.com/amd/MxGPU-Virtualization/tree/staging/smi-lib",
         "Community": "https://github.com/ROCm/ROCm/discussions",
         "Blogs": "https://rocm.blogs.amd.com/",
         "ROCm&#8482 Docs": "https://rocm.docs.amd.com",
         "ROCm Developer Hub": "https://www.amd.com/en/developer/resources/rocm-hub.html",
     },
     "show_toc_level": 4
 }
-html_title = "AMD SMI {} documentation".format(version_number)
+html_title = f"AMD SMI for Virtualization {version_number}"
 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"
-doxysphinx_enabled = True
 doxygen_project = {
-    "name": "AMD SMI C API reference",
+    "name": "AMD SMI C/C++ API reference",
     "path": "doxygen/doxy_build/xml",
 }