diff --git a/docs/archive/docs-1.x/index.md b/docs/archive/docs-1.x/index.md index f3569389e..0a8231be6 100644 --- a/docs/archive/docs-1.x/index.md +++ b/docs/archive/docs-1.x/index.md @@ -1,5 +1,10 @@ # Welcome to the [Omniperf](https://github.com/ROCm/omniperf) Documentation! +```{warning} +This version of the documentation is archived and contains out-of-date information. +See [Omniperf documentation](https://rocm.docs.amd.com/projects/omniperf/en/latest/index.html) for the latest version. +``` + ```eval_rst .. toctree:: :glob: diff --git a/docs/archive/docs-2.x/index.md b/docs/archive/docs-2.x/index.md index 3b375be0b..bd01b8735 100644 --- a/docs/archive/docs-2.x/index.md +++ b/docs/archive/docs-2.x/index.md @@ -1,5 +1,10 @@ # Welcome to the [Omniperf](https://github.com/ROCm/omniperf) Documentation! +```{warning} +This version of the documentation is archived and contains out-of-date information. +See [Omniperf documentation](https://rocm.docs.amd.com/projects/omniperf/en/latest/index.html) for the latest version. +``` + ```eval_rst .. toctree:: :glob: diff --git a/docs/how-to/analyze/cli.rst b/docs/how-to/analyze/cli.rst index 1a943265f..4563c0cf9 100644 --- a/docs/how-to/analyze/cli.rst +++ b/docs/how-to/analyze/cli.rst @@ -186,7 +186,7 @@ Walkthrough 3. Choose your own customized subset of metrics with the ``-b`` (or ``--block``) option. Or, build your own configuration following - `config_template `_. + `config_template `_. The following snippet shows how to generate a report containing only metric 2 (:doc:`System Speed-of-Light `). diff --git a/docs/install/core-install.rst b/docs/install/core-install.rst index 7629644dc..f33b97622 100644 --- a/docs/install/core-install.rst +++ b/docs/install/core-install.rst @@ -142,7 +142,7 @@ Install from source cd build cmake -DCMAKE_INSTALL_PREFIX=${INSTALL_DIR}/{{ config.version }} \ -DPYTHON_DEPS=${INSTALL_DIR}/python-libs \ - -DMOD_INSTALL_PATH=${INSTALL_DIR}/modulefiles .. + -DMOD_INSTALL_PATH=${INSTALL_DIR}/modulefiles/omniperf .. # install make install @@ -224,6 +224,9 @@ software stack. .. code-block:: shell $ sudo apt install omniperf + # Include omniperf in your system PATH + $ sudo update-alternatives --install /usr/bin/omniperf omniperf /opt/rocm/bin/omniperf 0 + # Install Python dependencies $ python3 -m pip install -r /opt/rocm/libexec/omniperf/requirements.txt .. tab-item:: Red Hat Enterprise Linux @@ -231,6 +234,9 @@ software stack. .. code-block:: shell $ sudo dnf install omniperf + # Include omniperf in your system PATH + $ sudo update-alternatives --install /usr/bin/omniperf omniperf /opt/rocm/bin/omniperf 0 + # Install Python dependencies $ python3 -m pip install -r /opt/rocm/libexec/omniperf/requirements.txt .. tab-item:: SUSE Linux Enterprise Server @@ -238,6 +244,9 @@ software stack. .. code-block:: shell $ sudo zypper install omniperf + # Include omniperf in your system PATH + $ sudo update-alternatives --install /usr/bin/omniperf omniperf /opt/rocm/bin/omniperf 0 + # Install Python dependencies $ python3 -m pip install -r /opt/rocm/libexec/omniperf/requirements.txt .. _core-install-rocprof-var: diff --git a/docs/install/grafana-setup.rst b/docs/install/grafana-setup.rst index a7486d286..39dca6e88 100644 --- a/docs/install/grafana-setup.rst +++ b/docs/install/grafana-setup.rst @@ -79,6 +79,13 @@ directory to begin. $ sudo docker-compose build $ sudo docker-compose up -d +.. note:: + + To troubleshoot Docker container build failures related to certificate verification, try + disabling any network proxy services on the host system. These proxy services can interfere + with OpenSSL's ability to retrieve a correct certificate chain when the container accesses + external websites. + The TCP ports for Grafana (``4000``) and MongoDB (``27017``) in the Docker container are mapped to ``14000`` and ``27018``, respectively, on the host side. diff --git a/docs/sphinx/static/css/o_custom.css b/docs/sphinx/static/css/o_custom.css index a6cbe5718..b4fe010b5 100644 --- a/docs/sphinx/static/css/o_custom.css +++ b/docs/sphinx/static/css/o_custom.css @@ -1,30 +1,8 @@ -:root { - --amd-teal-500: #00C2DE; - --amd-teal-750: #00788E; -} - /* Override PyData Sphinx Theme default colors */ html[data-theme='light'] { - --pst-color-primary: var(--amd-teal-750); - --pst-color-primary-bg: var(--amd-teal-500); --pst-color-table-row-hover-bg: #E2E8F0; } html[data-theme='dark'] { - --pst-color-primary: var(--amd-teal-500); - --pst-color-primary-bg: var(--amd-teal-750); --pst-color-table-row-hover-bg: #1E293B; } - -html[data-theme='light'], -html[data-theme='dark'] { - --pst-color-link: var(--pst-color-primary); -} - -a svg { - color: var(--pst-color-text-base); -} - -a svg:hover { - color: var(--pst-color-link-hover); -}