diff --git a/projects/amdsmi/docs/amdsmi_changelog_link.md b/projects/amdsmi/docs/amdsmi_changelog_link.md new file mode 100644 index 0000000000..66efc0fecd --- /dev/null +++ b/projects/amdsmi/docs/amdsmi_changelog_link.md @@ -0,0 +1,2 @@ +```{include} ../CHANGELOG.md +``` diff --git a/projects/amdsmi/docs/conf.py b/projects/amdsmi/docs/conf.py index 4e4806d16c..2b84ea8ce5 100644 --- a/projects/amdsmi/docs/conf.py +++ b/projects/amdsmi/docs/conf.py @@ -6,21 +6,8 @@ import subprocess -import urllib from rocm_docs import ROCmDocs -esmi_readme_link = "https://raw.githubusercontent.com/amd/esmi_ib_library/master/docs/README.md" -try: - # Try to override esmi_lib_readme_link.md with the github esmi readme contents - with urllib.request.urlopen(esmi_readme_link) as f: - esmi_readme = f.read().decode('utf-8') - - with open("./esmi_lib_readme_link.md", "w", encoding='utf-8') as f: - f.write(esmi_readme) -except urllib.error.URLError: - # don't care about the error because there is backup link in the file already - pass - get_version_year = r'sed -n -e "s/^#define\ AMDSMI_LIB_VERSION_YEAR\ //p" ../include/amd_smi/amdsmi.h' get_version_major = r'sed -n -e "s/^#define\ AMDSMI_LIB_VERSION_MAJOR\ //p" ../include/amd_smi/amdsmi.h' get_version_minor = r'sed -n -e "s/^#define\ AMDSMI_LIB_VERSION_MINOR\ //p" ../include/amd_smi/amdsmi.h' diff --git a/projects/amdsmi/docs/esmi_lib_readme_link.md b/projects/amdsmi/docs/esmi_lib_readme_link.md deleted file mode 100644 index 559434f106..0000000000 --- a/projects/amdsmi/docs/esmi_lib_readme_link.md +++ /dev/null @@ -1,3 +0,0 @@ -# ESMI Library README - -For more information, see the [ESMI Library README](https://raw.githubusercontent.com/amd/esmi_ib_library/master/docs/README.md) diff --git a/projects/amdsmi/docs/sphinx/_toc.yml.in b/projects/amdsmi/docs/sphinx/_toc.yml.in index c05c3bfbf0..fabff6292c 100644 --- a/projects/amdsmi/docs/sphinx/_toc.yml.in +++ b/projects/amdsmi/docs/sphinx/_toc.yml.in @@ -17,10 +17,10 @@ subtrees: title: Python CLI Tool - file: amdsmi_release_notes_link title: Python CLI Release Notes - - caption: Libraries + - caption: Changelog entries: - - file: esmi_lib_readme_link - title: ESMI Library + - file: amdsmi_changelog_link + title: AMD-SMI Changelog - caption: About entries: - file: license