docs: Remove redundant/stale docs

bump rocm-docs-core to 1.8.2

rm unused files

rm stale docs

fix sphinx conf

reorg docs

SWDEV-482203 -- add note to usage guides

update readmes

Change-Id: I9e0111ac8fe2a691ac964b27436ba47747c27904
Signed-off-by: Peter Park <Peter.Park@amd.com>
Dieser Commit ist enthalten in:
Peter Park
2024-10-02 14:42:34 -04:00
committet von Maisam Arif
Ursprung 6e843436f5
Commit e196f98dba
26 geänderte Dateien mit 2871 neuen und 7034 gelöschten Zeilen
+29 -27
Datei anzeigen
@@ -1,49 +1,51 @@
defaults:
numbered: false
root: index
subtrees:
- entries:
- file: what-is-AMDSMI.rst
title: What is AMD SMI?
subtrees:
- caption: Install
entries:
- file: install/install.rst
title: AMD SMI installation
- 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/using-amdsmi-for-C++.rst
title: Use AMD SMI for C++ library
- file: how-to/using-amdsmi-for-python.md
title: Use AMD SMI for Python library
- file: how-to/using-AMD-SMI-CLI-tool.md
title: Use AMD SMI CLI tool
- caption: API reference
- 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-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/modules
title: Modules
- file: doxygen/docBin/html/functions_data_fields
title: Data fields
- file: reference/amdsmi-py-api.md
title: Python API
- file: reference/changelog.md
title: Changelog
- caption: Tutorials
entries:
- url: https://github.com/ROCm/amdsmi/tree/amd-staging/example
title: AMD SMI GitHub samples
- url: https://github.com/ROCm/rocm_smi_lib/tree/amd-staging/docs
title: ROCm SMI lib GitHub samples
- 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
- file: license.md
+1 -1
Datei anzeigen
@@ -1 +1 @@
rocm-docs-core[api_reference]==1.4.0
rocm-docs-core[api_reference]==1.8.2
+28 -28
Datei anzeigen
@@ -6,9 +6,9 @@
#
accessible-pygments==0.0.5
# via pydata-sphinx-theme
alabaster==0.7.16
alabaster==1.0.0
# via sphinx
babel==2.15.0
babel==2.16.0
# via
# pydata-sphinx-theme
# sphinx
@@ -16,9 +16,9 @@ beautifulsoup4==4.12.3
# via pydata-sphinx-theme
breathe==4.35.0
# via rocm-docs-core
certifi==2024.6.2
certifi==2024.8.30
# via requests
cffi==1.16.0
cffi==1.17.1
# via
# cryptography
# pynacl
@@ -31,7 +31,7 @@ click==8.1.7
# sphinx-external-toc
click-log==0.4.0
# via doxysphinx
cryptography==42.0.8
cryptography==43.0.1
# via pyjwt
deprecated==1.2.14
# via pygithub
@@ -41,15 +41,15 @@ docutils==0.21.2
# myst-parser
# pydata-sphinx-theme
# sphinx
doxysphinx==3.3.8
doxysphinx==3.3.10
# via rocm-docs-core
fastjsonschema==2.19.1
fastjsonschema==2.20.0
# via rocm-docs-core
gitdb==4.0.11
# via gitpython
gitpython==3.1.43
# via rocm-docs-core
idna==3.7
idna==3.10
# via requests
imagesize==1.4.1
# via sphinx
@@ -67,13 +67,13 @@ markdown-it-py==3.0.0
# myst-parser
markupsafe==2.1.5
# via jinja2
mdit-py-plugins==0.4.1
mdit-py-plugins==0.4.2
# via myst-parser
mdurl==0.1.2
# via markdown-it-py
mpire==2.10.2
# via doxysphinx
myst-parser==3.0.1
myst-parser==4.0.0
# via rocm-docs-core
numpy==1.26.4
# via doxysphinx
@@ -83,11 +83,11 @@ packaging==24.1
# sphinx
pycparser==2.22
# via cffi
pydata-sphinx-theme==0.15.3
pydata-sphinx-theme==0.15.4
# via
# rocm-docs-core
# sphinx-book-theme
pygithub==2.3.0
pygithub==2.4.0
# via rocm-docs-core
pygments==2.18.0
# via
@@ -97,13 +97,13 @@ pygments==2.18.0
# sphinx
pyjson5==1.6.6
# via doxysphinx
pyjwt[crypto]==2.8.0
pyjwt[crypto]==2.9.0
# via pygithub
pynacl==1.5.0
# via pygithub
pyparsing==3.1.2
pyparsing==3.1.4
# via doxysphinx
pyyaml==6.0.1
pyyaml==6.0.2
# via
# myst-parser
# rocm-docs-core
@@ -112,15 +112,15 @@ requests==2.32.3
# via
# pygithub
# sphinx
rocm-docs-core[api-reference]==1.4.0
rocm-docs-core[api-reference]==1.8.2
# via -r requirements.in
smmap==5.0.1
# via gitdb
snowballstemmer==2.2.0
# via sphinx
soupsieve==2.5
soupsieve==2.6
# via beautifulsoup4
sphinx==7.3.7
sphinx==8.0.2
# via
# breathe
# myst-parser
@@ -135,33 +135,33 @@ sphinx-book-theme==1.1.3
# via rocm-docs-core
sphinx-copybutton==0.5.2
# via rocm-docs-core
sphinx-design==0.6.0
sphinx-design==0.6.1
# via rocm-docs-core
sphinx-external-toc==1.0.1
# via rocm-docs-core
sphinx-notfound-page==1.0.2
sphinx-notfound-page==1.0.4
# via rocm-docs-core
sphinxcontrib-applehelp==1.0.8
sphinxcontrib-applehelp==2.0.0
# via sphinx
sphinxcontrib-devhelp==1.0.6
sphinxcontrib-devhelp==2.0.0
# via sphinx
sphinxcontrib-htmlhelp==2.0.5
sphinxcontrib-htmlhelp==2.1.0
# via sphinx
sphinxcontrib-jsmath==1.0.1
# via sphinx
sphinxcontrib-qthelp==1.0.7
sphinxcontrib-qthelp==2.0.0
# via sphinx
sphinxcontrib-serializinghtml==1.1.10
sphinxcontrib-serializinghtml==2.0.0
# via sphinx
tomli==2.0.1
tomli==2.0.2
# via sphinx
tqdm==4.66.4
tqdm==4.66.5
# via mpire
typing-extensions==4.12.2
# via
# pydata-sphinx-theme
# pygithub
urllib3==2.2.1
urllib3==2.2.3
# via
# pygithub
# requests