Files

T

Gopesh Bhardwaj 076f4d8427 readthedocs updates (#877 )

* readthedocs updates

* Adding License

* correcting table of contents path

* Move doc requirements to sphinx dir

* Compile requirements.txt

* Update path to reqs

* Adding missing python module

* changing sphinx version

* changing docutils version

* enabling sphinx extensions

* trying sphinx-rtd-theme

* Remove unused doc configs

* Remove unused html theme options

* Add files to toc

* temp commit to test

* updating environment.yml for CI build

* Update doc requirements

To include rocprofiler-sdk in projects.yaml

* Set external_projects_current_project as rocprofiler-sdk

* Exclude external projects

* Fix warning for missing static path

* updating conf.py

* Removing reST syntax

* Use rocm-docs-core doxygen integration

* Remove RST syntax from Markdown files

* Generate doxyfile post checkout on RTD

* Use custom RTD env

* Specify mambaforge

* Put conda before post checkout cmd

* Add doxyfile for RTD

* Run cmake from conf.py

* Update environment.yml

* Use mambaforge

* Fix path to environment.yml

* Call build doxyfile

* Add Developer API title to Doxyfile

* Config version header

* Fix typo in conf.py

* Format fix for conf.py

* Increasing timeout for build-docs-from-source

* Remove README as mainpage for doxyfile

* Fix formatting in conf.py

---------

Co-authored-by: Sam Wu <22262939+samjwu@users.noreply.github.com>

[ROCm/rocprofiler-sdk commit: a60c4def00]

2024-06-22 00:10:54 +05:30

1.8 KiB

Исходник Ответственный История

Installation

Operating System

ROCprofiler is only supported on Linux. The following distributions are tested:

Ubuntu 20.04
Ubuntu 22.04
OpenSUSE 15.4
RedHat 8.8

Other OS distributions may be supported but have yet to be tested.

Identifying the Operating System

If you are unsure of the operating system and version, the /etc/os-release and /usr/lib/os-release files contain operating system identification data for Linux systems.

$ cat /etc/os-release
NAME="Ubuntu"
VERSION="20.04.4 LTS (Focal Fossa)"
ID=ubuntu
...
VERSION_ID="20.04"
...

The relevant fields are ID and the VERSION_ID.

Installing ROCprofiler from source

Build Requirements

ROCprofiler needs a CMake (https://cmake.org/) version 3.21 or higher.

If the system installed 'CMake' is too old, installing a new version can be done through several methods. One of the easiest options is to use PyPi (i.e., python’s pip):

pip install --user 'cmake==3.22.0'
export PATH=${HOME}/.local/bin:${PATH}

Building ROCprofiler

git clone https://git@github.com:ROCm/rocprofiler-sdk.git rocprofiler-sdk-source  
cmake                                         \
      -B rocprofiler-sdk-build                \
      -D ROCPROFILER_BUILD_TESTS=ON           \
      -D ROCPROFILER_BUILD_SAMPLES=ON         \
      -D ROCPROFILER_BUILD_DOCS=ON            \
      -D CMAKE_INSTALL_PREFIX=/opt/rocm       \
       rocprofiler-sdk-source

cmake --build rocprofiler-sdk-build --target all --parallel 8

Testing ROCprofiler

To run the built tests, cd into the rocprofiler-sdk-build directory and run:

ctest --output-on-failure -O ctest.all.log

Installing ROCprofiler

To install ROCprofiler from the rocprofiler-sdk-build directory, run:

cmake --build rocprofiler-sdk-build --target install

1.8 KiB Исходник Ответственный История Убрать экранирование Экранировать