2
0
Ficheiros
rocm-systems/projects/rocprofiler-systems/docs/sphinx/_toc.yml.in
T
David Galiffi d13617cf91 Update branding to ROCm Systems Profiler in documentation (#2)
* Update branding in docs

* Rename image used in documentation

* Update names of code samples.

In the code snippets, the "-" is not valid. ex., rocprof-sys_ --> rocprofsys_

* Update ASCII art

* update Doxyfile strip_from_path

* Add a "Formerly known as" message.

* Fixed typo in product name

ROCm Systems Profiler, not ROCm Profiler System

* Add "Omnitrace" back to the metadata keywords

* Update "install via package manager" section

* Update paths to user API files

* Rename configuration and environment settings

* Update Doxyfiles

Update publisher name & ID to "AMD".
Update bundle ID to "rocprofiler-systems"

* Update docs/what-is-rocprof-sys.rst

Co-authored-by: Jeffrey Novotny <jnovotny@amd.com>

* Update docs/conceptual/data-collection-modes.rst

Co-authored-by: Jeffrey Novotny <jnovotny@amd.com>

* Update docs/tutorials/video-tutorials.rst

Co-authored-by: Jeffrey Novotny <jnovotny@amd.com>

* Update docs/conceptual/rocprof-sys-feature-set.rst

Co-authored-by: Jeffrey Novotny <jnovotny@amd.com>

* Update docs/how-to/configuring-runtime-options.rst

Co-authored-by: Jeffrey Novotny <jnovotny@amd.com>

* Update docs/how-to/configuring-validating-environment.rst

Co-authored-by: Jeffrey Novotny <jnovotny@amd.com>

* Update docs/how-to/general-tips-using-rocprof-sys.rst

Co-authored-by: Jeffrey Novotny <jnovotny@amd.com>

* Update docs/reference/rocprof-sys-glossary.rst

Co-authored-by: Jeffrey Novotny <jnovotny@amd.com>

* Update docs/reference/development-guide.rst

Co-authored-by: Jeffrey Novotny <jnovotny@amd.com>

* Update docs/how-to/instrumenting-rewriting-binary-application.rst

Co-authored-by: Jeffrey Novotny <jnovotny@amd.com>

* Update docs/install/quick-start.rst

Co-authored-by: Jeffrey Novotny <jnovotny@amd.com>

* Note that videos were recorded using the "Omnitrace" name.

* Rebase and update some file paths

* Update paths to doc images

* Update Omnitrace references in code snippets

* Rename examples still using the "omni" prefix.

* Update docs/how-to/performing-causal-profiling.rst

Co-authored-by: Jeffrey Novotny <jnovotny@amd.com>

* Update docs/how-to/profiling-python-scripts.rst

Co-authored-by: Jeffrey Novotny <jnovotny@amd.com>

* Update docs/how-to/sampling-call-stack.rst

Co-authored-by: Jeffrey Novotny <jnovotny@amd.com>

* Update docs/how-to/understanding-rocprof-sys-output.rst

Co-authored-by: Jeffrey Novotny <jnovotny@amd.com>

* Update docs/install/install.rst

Co-authored-by: Jeffrey Novotny <jnovotny@amd.com>

---------

Co-authored-by: Peter Park <peter.park@amd.com>
Co-authored-by: Jeffrey Novotny <jnovotny@amd.com>

[ROCm/rocprofiler-systems commit: 032d39f15c]
2024-10-17 15:19:19 -04:00

71 linhas
2.3 KiB
Plaintext

# Anywhere {branch} is used, the branch name will be substituted.
# These comments will also be removed.
defaults:
numbered: False
maxdepth: 6
root: index
subtrees:
- entries:
- file: what-is-rocprof-sys.rst
- caption: Install
entries:
- file: install/quick-start.rst
title: ROCm Systems Profiler quick start
- file: install/install.rst
title: ROCm Systems Profiler installation guide
- caption: Tutorials
entries:
- url: https://github.com/ROCm/rocprofiler-systems/tree/amd-mainline/examples
title: GitHub examples
- file: tutorials/video-tutorials.rst
title: Video tutorials
- caption: How to
entries:
- file: how-to/configuring-validating-environment.rst
title: Configuring and validating the environment
- file: how-to/configuring-runtime-options.rst
title: Configuring runtime options
- file: how-to/sampling-call-stack.rst
title: Sampling the call stack
- file: how-to/instrumenting-rewriting-binary-application.rst
title: Instrumenting and rewriting a binary application
- file: how-to/performing-causal-profiling.rst
title: Performing causal profiling
- file: how-to/understanding-rocprof-sys-output.rst
title: Understanding the ROCm Systems Profiler output
- file: how-to/profiling-python-scripts.rst
title: Profiling Python scripts
- file: how-to/using-rocprof-sys-api.rst
title: Using the ROCm Systems Profiler API
- file: how-to/general-tips-using-rocprof-sys.rst
title: General tips for using ROCm Systems Profiler
- caption: Conceptual
entries:
- file: conceptual/data-collection-modes.rst
title: Data collection modes
- file: conceptual/rocprof-sys-feature-set.rst
title: The ROCm Systems Profiler feature set and use cases
- caption: Reference
entries:
- file: reference/development-guide.rst
title: Development guide
- file: reference/rocprof-sys-glossary.rst
title: ROCm Systems Profiler glossary
- file: doxygen/html/files
title: API library
- file: doxygen/html/functions
title: Class member functions
- file: doxygen/html/globals
title: Globals
- file: doxygen/html/annotated
title: Classes, structures, and interfaces
- caption: About
entries:
- file: license.md