Docs: Use Omnitrace's version number in installer download command

ROCm / omnitrace

Omnitrace: Application Profiling, Tracing, and Analysis

https://rocm.docs.amd.com/projects/omnitrace/en/latest/

MIT License

297 stars 27 forks source link

Docs: Use Omnitrace's version number in installer download command #388

Open peterjunpark opened 2 weeks ago

peterjunpark commented 2 weeks ago

This PR:

Updates conf.py to non-legacy rocm-docs-core setup
Injects Omnitrace's version number into the download command for omnitrace-installer.py (quick-start.rst)
- Fixes an issue causing the download url (https://github.com/ROCm/omnitrace/releases/latest/download/omnitrace-install.py) to not work if the latest release is a rocm tag

dgaliffiAMD commented 2 weeks ago

Updated reference to "omniperf" to "omnitrace" in description.

peterjunpark commented 2 weeks ago

@dgaliffiAMD

FYI, with this change, users will only see the latest Omnitrace version number (i.e., 1.12.0) in main which is effectively staging documentation.

The latest and other versions of the docs will show the Omnitrace version associated with that ROCm release (i.e., 1.11.2). This means the "default" version of the docs will not show the latest Omnitrace version (1.12.0). So, this actually changes the installation instructions.

This might not be what you expected?