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]
This commit is contained in:
Peter Park
2024-11-12 09:43:55 -05:00
committed by Maisam Arif
szülő f01eea6077
commit 49592ef24f
3 fájl változott, egészen pontosan 20 új sor hozzáadva és 1740 régi sor törölve
+9 -9
Fájl megtekintése
@@ -5,18 +5,18 @@
# https://www.sphinx-doc.org/en/master/usage/configuration.html
import re
import shutil
# get version number to print in docs
def get_version_info(filepath):
with open(filepath, 'r') as f:
with open(filepath, "r") as f:
content = f.read()
version_pattern = (
r'^#define\s+AMDSMI_LIB_VERSION_YEAR\s+(\d+)\s*$|'
r'^#define\s+AMDSMI_LIB_VERSION_MAJOR\s+(\d+)\s*$|'
r'^#define\s+AMDSMI_LIB_VERSION_MINOR\s+(\d+)\s*$|'
r'^#define\s+AMDSMI_LIB_VERSION_RELEASE\s+(\d+)\s*$'
r"^#define\s+AMDSMI_LIB_VERSION_YEAR\s+(\d+)\s*$|"
r"^#define\s+AMDSMI_LIB_VERSION_MAJOR\s+(\d+)\s*$|"
r"^#define\s+AMDSMI_LIB_VERSION_MINOR\s+(\d+)\s*$|"
r"^#define\s+AMDSMI_LIB_VERSION_RELEASE\s+(\d+)\s*$"
)
matches = re.findall(version_pattern, content, re.MULTILINE)
@@ -29,10 +29,10 @@ def get_version_info(filepath):
else:
raise ValueError("Couldn't find all VERSION numbers.")
# copy changelog to docs/
shutil.copy2("../CHANGELOG.md", "./reference/changelog.md")
version_year, version_major, version_minor, version_release = get_version_info('../include/amd_smi/amdsmi.h')
version_year, version_major, version_minor, version_release = get_version_info(
"../include/amd_smi/amdsmi.h"
)
version_number = f"{version_year}.{version_major}.{version_minor}.{version_release}"
# project info
@@ -12,6 +12,10 @@ hardware through a simple and accessible [API](../reference/amdsmi-py-api.md).
Compatible with Python 3.6 and higher, this library requires the AMD driver to
be loaded for initialization -- review the [prerequisites](#install_reqs).
```{seealso}
Refer to the [Python library API reference](../reference/amdsmi-py-api.md).
```
## Get started
To get started, the `amdsmi` folder should be copied and placed next to
A különbségek nem kerülnek megjelenítésre, mivel a fájl túl nagy Load Diff