diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index fab8bc6347..8a940010dc 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -82,6 +82,7 @@ jobs: heavy: ${{ steps.filter.outputs.heavy || steps.all.outputs.forced }} lint: ${{ steps.filter.outputs.lint || steps.all.outputs.forced }} tpn: ${{ steps.filter.outputs.tpn || steps.all.outputs.forced }} + docs: ${{ steps.filter.outputs.docs || steps.all.outputs.forced }} steps: - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1 @@ -148,6 +149,15 @@ jobs: - 'ruff.toml' - 'PSScriptAnalyzerSettings.psd1' - '.github/workflows/**' + # Sphinx docs site: the doc sources themselves, plus README.md and + # CONTRIBUTING.md, which several pages single-source via MyST + # `{include}` directives, plus the build config/toolchain pins. + docs: + - 'docs/rocm-docs/**' + - 'README.md' + - 'CONTRIBUTING.md' + - '.readthedocs.yaml' + - '.github/workflows/**' - name: Force full run off pull requests id: all @@ -618,6 +628,37 @@ jobs: run: | "${HAWKEYE_INSTALL_DIR}/hawkeye" check + docs-build: + name: Sphinx docs build (-W) + runs-on: ubuntu-latest + timeout-minutes: 20 + needs: [changes] + # A manual E2E dispatch only exercises the E2E jobs; skip the rest. Off a + # dispatch, `needs.changes` never ran, so short-circuit on event_name first. + if: github.event_name != 'workflow_dispatch' && needs.changes.outputs.docs == 'true' + steps: + - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1 + + - name: Cache pip packages + id: cache-pip + uses: actions/cache@55cc8345863c7cc4c66a329aec7e433d2d1c52a9 # v6.1.0 + with: + path: ~/.cache/pip + key: ${{ runner.os }}-docs-pip-${{ hashFiles('docs/rocm-docs/sphinx/requirements.txt') }} + + - name: Install Sphinx toolchain + run: | + python3 -m venv .docs-venv + .docs-venv/bin/pip install -q -r docs/rocm-docs/sphinx/requirements.txt + + # Same source Sphinx points at (docs/rocm-docs/conf.py) and the same + # -W (warnings-as-errors) mode read-the-docs builds with, so a broken + # MyST include, dead xref, or toctree gap fails CI instead of surfacing + # as a silent RTD build failure after merge. + - name: Build docs (warnings as errors) + run: | + .docs-venv/bin/sphinx-build -b html docs/rocm-docs /tmp/rocm-cli-docs -W + commit-signatures: name: Commit signatures + sign-off runs-on: ubuntu-latest diff --git a/.gitignore b/.gitignore index 6a19bd1e30..fdec19493e 100644 --- a/.gitignore +++ b/.gitignore @@ -17,3 +17,7 @@ __pycache__/ /plans/ /workspace/ /e2e-consolidated-report.md + +# Sphinx docs: _toc.yml is generated from _toc.yml.in at build time +docs/rocm-docs/sphinx/_toc.yml +docs/rocm-docs/_build/ diff --git a/.readthedocs.yaml b/.readthedocs.yaml new file mode 100644 index 0000000000..98f09d9343 --- /dev/null +++ b/.readthedocs.yaml @@ -0,0 +1,13 @@ +version: 2 + +build: + os: ubuntu-24.04 + tools: + python: "3.12" + +sphinx: + configuration: docs/rocm-docs/conf.py + +python: + install: + - requirements: docs/rocm-docs/sphinx/requirements.txt diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 45be3df779..a9e1c9fa86 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -10,13 +10,13 @@ Thank you for your interest in contributing. This document explains how to get s ## Code of Conduct -By participating in this project you agree to abide by the [Code of Conduct](CODE_OF_CONDUCT.md). +By participating in this project you agree to abide by the [Code of Conduct](https://github.com/ROCm/rocm-cli/blob/main/CODE_OF_CONDUCT.md). -## Issue Tracking +## Issue tracking -Bug reports and feature requests are tracked as [GitHub Issues](../../issues). Before opening a new issue, search existing ones to avoid duplicates. +Bug reports and feature requests are tracked as [GitHub Issues](https://github.com/ROCm/rocm-cli/issues). Before opening a new issue, search existing ones to avoid duplicates. -## Branch and Commit Naming +## Branch and commit naming Use [Conventional Commits](https://www.conventionalcommits.org/) for commit messages: @@ -34,7 +34,7 @@ feat/vllm-multi-gpu fix/vram-probe-fallback ``` -## Development Setup +## Development setup Prerequisites: Rust (see `rust-toolchain.toml` for the pinned version) and [uv](https://github.com/astral-sh/uv) (for prek and scripts). @@ -74,7 +74,7 @@ cargo install cargo-about@0.9.1 --locked --features cli # optional, for THIRD_ See `docs/testing.md` for the full test guide and `docs/manual-testing.md` for manual QA steps. -## Making Changes +## Making changes 1. **Fork** the repository and create a branch from `main`. 2. **Make your changes.** Keep commits focused — one logical change per commit. @@ -84,7 +84,7 @@ See `docs/testing.md` for the full test guide and `docs/manual-testing.md` for m ### Commit signing and sign-off -Commits must be both cryptographically **signed** and carry a DCO **`Signed-off-by`** trailer. Use `git commit -s` to add the trailer automatically. This is enforced by the prek hooks and by a blocking CI check. +Commits must be both cryptographically **signed** and carry a Developer Certificate of Origin (DCO) **`Signed-off-by`** trailer. Use `git commit -s` to add the trailer automatically. This is enforced by the prek hooks and by a blocking CI check. Enable SSH signing once with: @@ -102,10 +102,10 @@ See `docs/commit-signatures.md` for GPG signing, GitHub "Verified" status, and t - No secrets, credentials, or internal hostnames in committed files - Third-party dependencies declared in `Cargo.lock`; license headers present on new source files (see `licenserc.toml`) -## Reporting Security Issues +## Reporting security issues -Do **not** open a public GitHub Issue for security vulnerabilities. See [SECURITY.md](SECURITY.md) for the responsible disclosure process. +Do **not** open a public GitHub Issue for security vulnerabilities. See [SECURITY.md](https://github.com/ROCm/rocm-cli/blob/main/SECURITY.md) for the responsible disclosure process. ## License -By contributing you agree that your contributions will be licensed under the [MIT License](LICENSE.TXT). +By contributing you agree that your contributions will be licensed under the [MIT License](https://github.com/ROCm/rocm-cli/blob/main/LICENSE.TXT). diff --git a/README.md b/README.md index b2e3c6690e..26edffe22e 100644 --- a/README.md +++ b/README.md @@ -23,19 +23,21 @@ SPDX-License-Identifier: MIT ROCm CLI is a command-line tool for setting up and running local AI on AMD GPUs, with a full-screen TUI dashboard for GPU telemetry, model serving, and chat. -A single prebuilt binary for Linux and Windows (x86_64). No Python, Rust, or -existing ROCm install required. Ships with inference engine adapters for -Lemonade and vLLM. +It ships as a single prebuilt binary for Linux and Windows (x86_64), needs no +Python, Rust, or existing ROCm install, and includes inference engine adapters +for Lemonade and vLLM. + | Platform | Prebuilt binary | Notes | |---|---|---| | Linux (x86_64) | Yes | Ubuntu 24.04 or newer; full support, including the live dashboard and both inference engines | | Windows (x86_64) | Yes | CLI and Lemonade serving; no live dashboard or vLLM | -| WSL2 (x86_64) | Yes (Linux binary) | Ubuntu 24.04 or newer; full support, including the live dashboard; see [docs/wsl.md](docs/wsl.md) for setup | +| WSL2 (x86_64) | Yes (Linux binary) | Ubuntu 24.04 or newer; full support, including the live dashboard; see [docs/wsl.md](https://github.com/ROCm/rocm-cli/blob/main/docs/wsl.md) for setup | | macOS | No | No official installer, release, CI, or QA coverage | + Live dashboard telemetry requires Linux or WSL2 (see -[Interactive interfaces](#interactive-interfaces)). vLLM serving is Linux/WSL2 +[Interactive interfaces](#interactive-interfaces)). vLLM serving is Linux or WSL2 only (see [docs/vllm.md](docs/vllm.md)). The minimum supported Linux release, native or under WSL2, is Ubuntu 24.04. On @@ -47,7 +49,7 @@ glibc 2.39 and `GLIBCXX_3.4.33`. > [!IMPORTANT] > **Tech Preview** -- This software is provided as-is, without warranty or -> guarantee of stability. APIs, commands, and behavior may change without +> guarantee of stability. APIs, commands, and behavior might change without > notice. Intended for experimentation and early feedback only. ## Demos @@ -78,30 +80,32 @@ The installer downloads a prebuilt bundle, verifies its SHA-256 checksum, installs the `rocm` and `rocmd` binaries into `~/.local/bin`, and adds that directory to your shell `PATH`. Rerun it any time to upgrade. -### Linux / WSL (x86_64) - -Only nightly builds are published today, so pass the `nightly` channel: +### Linux and WSL (x86_64) ```bash -curl -fsSL https://raw.githubusercontent.com/ROCm/rocm-cli/main/install.sh | sh -s -- nightly +curl -fsSL https://raw.githubusercontent.com/ROCm/rocm-cli/main/install.sh | sh ``` -Once a stable release exists, omit the argument to track the default `release` -channel instead: +This tracks the default `release` channel. For nightly builds, pass the +`nightly` channel instead: ```bash -curl -fsSL https://raw.githubusercontent.com/ROCm/rocm-cli/main/install.sh | sh +curl -fsSL https://raw.githubusercontent.com/ROCm/rocm-cli/main/install.sh | sh -s -- nightly ``` ### Windows (x86_64, PowerShell) ```powershell -$env:ROCM_CLI_CHANNEL = "nightly" irm https://raw.githubusercontent.com/ROCm/rocm-cli/main/install.ps1 | iex ``` -Drop the `ROCM_CLI_CHANNEL` line to track the default `release` channel once a -stable release is published. +This tracks the default `release` channel. For nightly builds, set +`ROCM_CLI_CHANNEL` to `nightly` first: + +```powershell +$env:ROCM_CLI_CHANNEL = "nightly" +irm https://raw.githubusercontent.com/ROCm/rocm-cli/main/install.ps1 | iex +``` ## Build from source @@ -131,11 +135,13 @@ Or copy the release binaries onto your `PATH`: install -m 0755 target/release/rocm target/release/rocmd ~/.local/bin/ ``` -See [CONTRIBUTING.md](CONTRIBUTING.md) for the full development setup, test +See [CONTRIBUTING.md](https://github.com/ROCm/rocm-cli/blob/main/CONTRIBUTING.md) for the full development setup, test commands, and commit-signing requirements. ## First run +Launch ROCm CLI with no arguments: + ``` rocm ``` @@ -173,7 +179,7 @@ five tabs (switch with `Tab`/`Shift+Tab` or number keys `1`–`5`): | Tab | What it shows | |---|---| | **Home** | At-a-glance status: GPU, active runtime, running servers | -| **ROCm** | Guided ROCm/runtime actions with inline details | +| **ROCm** | Guided ROCm and runtime actions with inline details | | **Serving** | Start, inspect, and manage model servers | | **Observe** | Live GPU utilization, instances, and benchmark telemetry | | **Chat** | Assistant chat backed by a local server or configured provider | @@ -182,7 +188,7 @@ Live mode reads telemetry over a Unix domain socket, so it requires Linux or WSL. Use `rocm dash --demo` for a synthetic session that runs anywhere without a GPU or daemon. -## Getting started +## Configure ROCm and serve a model Before serving a model, ensure a managed ROCm runtime is configured: @@ -206,9 +212,6 @@ box. You can also serve any compatible Hugging Face model directly — see [Model serving](#model-serving) for the GGUF-vs-safetensors rule, since which form works depends on the engine your GPU selects. -Use `rocm model` to see available model recipes and their GPU memory -requirements. - ## Quick reference | Command | Description | @@ -225,11 +228,28 @@ requirements. ## Commands +### Examine + +``` +rocm examine [--json] [--framework auto|pytorch|llama-cpp|skip] +``` + +Checks this computer's GPU, ROCm install, engines, and managed setup +folders — the command to run first to see whether a system is ready, and +what `rocm install sdk` and `rocm serve` will see. `--json` emits a +machine-readable report for diagnosis tooling instead of the human-readable +summary. `--framework` controls which ML framework the `--json` report probes +for its ROCm build and compiled GPU architectures: `auto` (the default) tries +PyTorch, then falls back to llama.cpp; `pytorch` or `llama-cpp` probe only +that framework; `skip` runs no framework probe at all, which is fastest and +still enough to answer GPU and driver questions. `--framework` only affects +the JSON report, not the human-readable one. + ### ROCm installation ``` rocm install sdk [--channel release|nightly] [--format wheel|tarball] - [--version X.Y.Z | --build-date YYYY-MM-DD] + [--version x.y.z | --build-date YYYY-MM-DD] [--family gfx110X-all] [--prefix PATH] [--dry-run] rocm install driver [--dkms] [--yes] [--dry-run] [--reconcile] @@ -257,7 +277,7 @@ rocm runtimes adopt --python [--root ] [--runtime-id ID] ``` `adopt` registers an existing TheRock-based Python environment as a managed -runtime. It does not work with standard ROCm package installs (e.g. +runtime. It does not work with standard ROCm package installs (for example, `/opt/rocm`); use `rocm install sdk` instead. ### Disk space @@ -345,15 +365,14 @@ to stop the server instead. `--managed` is the explicit form of the default background behavior. `--no-smoke-test` skips the post-startup inference probe. Which model form to pass depends on the engine your GPU selects. The Lemonade -engine (Ryzen AI / Radeon) serves llama.cpp **GGUF** models — pass a GGUF repo -with an explicit quantization variant, e.g. +engine (Ryzen AI or Radeon) serves llama.cpp **GGUF** models — pass a GGUF repo +with an explicit quantization variant, for example, `rocm serve unsloth/Qwen3-0.6B-GGUF:Q4_0`. The vLLM engine (Instinct) serves -**safetensors** repos, e.g. `rocm serve Qwen/Qwen2.5-1.5B-Instruct`. A +**safetensors** repos, such as `rocm serve Qwen/Qwen2.5-1.5B-Instruct`. A safetensors-only id has no GGUF build, so serving it through Lemonade fails -rather than silently substituting a different model. Short -aliases from `rocm model` may not resolve with all engines. +rather than silently substituting a different model. -Some models (e.g., Llama) are gated and require HuggingFace authentication. +Some models (such as Llama) are gated and require HuggingFace authentication. Log in with `huggingface-cli login` or set `HF_TOKEN` in your environment before serving gated models. @@ -367,26 +386,6 @@ model across multiple GPUs is not supported. Because selection uses the `amd-smi` ordinal but is applied via `HIP_VISIBLE_DEVICES`, rocm-cli warns when `ROCR_VISIBLE_DEVICES` is set, since the two orderings can diverge. -Show recommended models and hardware compatibility: - -``` -rocm model [--verbose] -``` - -`rocm model` prints a curated catalog of popular open-weight models grouped by -the hardware path they target — Strix Halo (Lemonade / llama.cpp) and MI300X -(vLLM) — using canonical Hugging Face ids, and shows for each the quantization -that fits a single GPU. Strix Halo entries use the `owner/repo:variant` GGUF form -(e.g. `unsloth/Qwen3.6-35B-A3B-GGUF:Q4_K_M`) that `rocm serve` needs; MI300X -entries serve at BF16. This catalog ships inside the binary, so it is available -offline; when a recipe index is configured instead, the header names it. -`--verbose` also lists the other recipes (the default assistant and smoke/test -paths) that `rocm serve` can still resolve but that are hidden from the list. - -The catalog is only a starting point: you can serve any compatible Hugging Face -model by passing its id to `rocm serve` — `owner/repo` for vLLM, or -`owner/repo:` for a Lemonade GGUF. - Manage background servers started with `--managed`: ``` @@ -449,6 +448,11 @@ Optional background checks that can propose or apply changes automatically. ### Configuration +Show or change rocm-cli's saved settings — the default engine and runtime, +which runtime each engine prefers, local GPU telemetry opt-in, and the +provider used for chat, automations, and ambiguous natural-language plans +(including enabling providers and storing their API keys). + ``` rocm config show rocm config set-default-engine diff --git a/docs/rocm-docs/about/contributing.md b/docs/rocm-docs/about/contributing.md new file mode 100644 index 0000000000..7a86854ecd --- /dev/null +++ b/docs/rocm-docs/about/contributing.md @@ -0,0 +1,19 @@ + + +# Contributing + +```{include} ../../../CONTRIBUTING.md +:start-after: "# Contributing to ROCm CLI" +``` + +## More docs + + +```{include} ../../../README.md +:start-after: "## More docs" +``` diff --git a/docs/rocm-docs/about/license.md b/docs/rocm-docs/about/license.md new file mode 100644 index 0000000000..16436f19f2 --- /dev/null +++ b/docs/rocm-docs/about/license.md @@ -0,0 +1,11 @@ + + +# License + +```{literalinclude} ../../../LICENSE.TXT +:language: text +``` diff --git a/docs/rocm-docs/commands.md b/docs/rocm-docs/commands.md new file mode 100644 index 0000000000..02e3680530 --- /dev/null +++ b/docs/rocm-docs/commands.md @@ -0,0 +1,21 @@ + + +# Command reference + +```{include} ../../README.md +:start-after: "## Commands" +:end-before: "and a chat tab backed by any configured provider." +``` + +and a chat tab backed by any configured provider. See +[Interactive interfaces](getting-started.md#interactive-interfaces) for the +tab breakdown. + +```{include} ../../README.md +:start-after: "for the tab breakdown." +:end-before: "## Contributing" +``` diff --git a/docs/rocm-docs/conf.py b/docs/rocm-docs/conf.py new file mode 100644 index 0000000000..72cc906ee4 --- /dev/null +++ b/docs/rocm-docs/conf.py @@ -0,0 +1,85 @@ +# Copyright © Advanced Micro Devices, Inc., or its affiliates. +# +# SPDX-License-Identifier: MIT + +# Configuration file for the Sphinx documentation builder. +# pylint: disable=invalid-name + +import logging + + +class _SuppressKnownUnreleasedRocmDocsCoreWarnings(logging.Filter): + """rocm-cli isn't registered in rocm-docs-core's shared projects.yaml + catalog yet, so `external_projects_current_project` can never resolve + until that's added upstream. Separately, the "rocm-ai" flavor used here + was only added to rocm-docs-core after its last release, so the + published package doesn't recognize it yet and falls back to "rocm". + Both are purely informational until rocm-docs-core catches up, and + would otherwise permanently block a `-W` build.""" + + _IGNORED_SUBSTRINGS = ( + "not found in projects", + 'Unsupported theme flavor "rocm-ai"', + ) + + def filter(self, record: logging.LogRecord) -> bool: + message = record.getMessage() + return not any(s in message for s in self._IGNORED_SUBSTRINGS) + + +_suppress_known_unreleased_rocm_docs_core_warnings = ( + _SuppressKnownUnreleasedRocmDocsCoreWarnings() +) +for _logger_name in ("sphinx.rocm_docs.projects", "sphinx.rocm_docs.theme"): + logging.getLogger(_logger_name).addFilter( + _suppress_known_unreleased_rocm_docs_core_warnings + ) + +# -- Project information --------------------------------------------------- + +project = "ROCm CLI" +author = "Advanced Micro Devices, Inc." +# pylint: disable=redefined-builtin +copyright = "Copyright (c) Advanced Micro Devices, Inc. All rights reserved." +# pylint: enable=redefined-builtin + +# -- General configuration ------------------------------------------------- + +html_theme = "rocm_docs_theme" +html_theme_options = { + "flavor": "rocm-ai", + "use_repository_button": True, + "use_download_button": True, + # Pin these instead of letting rocm-docs-core infer them from the local + # git branch: CI's pull_request checkout leaves a detached HEAD on the + # synthetic merge ref, which resolves to an empty repository_url and + # crashes sphinx_book_theme's repository button. + "repository_url": "https://github.com/ROCm/rocm-cli", + "repository_branch": "main", +} +html_title = "ROCm CLI documentation" +# myst.header: `:start-after:` on included README sections strips the heading +# line itself, so the first heading in the chunk renders one level below its +# expected depth; docutils re-normalizes this in the rendered output, so it's +# cosmetic here. +suppress_warnings = ["etoc.toctree", "myst.header"] +external_toc_path = "./sphinx/_toc.yml" +external_projects_current_project = "rocm-cli" +# No page here cross-references another ROCm project via intersphinx, and the +# default ("all") tries to fetch inventories for every project in +# rocm_docs' bundled projects.yaml — several of which 404 or have moved on +# rocm.docs.amd.com, which would make a `-W` (warnings-as-errors) CI build +# flaky against failures this repo can't fix. +external_projects = [] +extensions = [ + "rocm_docs", + "sphinx_design", +] +exclude_patterns = [] + +# -- Sphinx setup ---------------------------------------------------------- + + +def setup(app): + """Sphinx setup""" + return {"parallel_read_safe": True, "parallel_write_safe": True} diff --git a/docs/rocm-docs/demos.md b/docs/rocm-docs/demos.md new file mode 100644 index 0000000000..9540185de0 --- /dev/null +++ b/docs/rocm-docs/demos.md @@ -0,0 +1,12 @@ + + +# Demos + +```{include} ../../README.md +:start-after: "## Demos" +:end-before: " + +# Getting started with ROCm CLI + +```{include} ../../README.md +:start-after: "## First run" +:end-before: "## Interactive interfaces" +``` + +## Configure ROCm and serve a model + +```{include} ../../README.md +:start-after: "## Configure ROCm and serve a model" +:end-before: "You can also serve any compatible Hugging Face model directly" +``` + +You can also serve any compatible Hugging Face model directly — see +[Model serving](commands.md#model-serving) for the GGUF-vs-safetensors rule, +since which form works depends on the engine your GPU selects. + +```{include} ../../README.md +:start-after: "form works depends on the engine your GPU selects." +:end-before: "## Commands" +``` + +## Interactive interfaces + +```{include} ../../README.md +:start-after: "## Interactive interfaces" +:end-before: "## Configure ROCm and serve a model" +``` diff --git a/docs/rocm-docs/index.rst b/docs/rocm-docs/index.rst new file mode 100644 index 0000000000..f5143d0069 --- /dev/null +++ b/docs/rocm-docs/index.rst @@ -0,0 +1,43 @@ +.. meta:: + :description: ROCm CLI documentation. + :keywords: ROCm CLI, ROCm, AMD, GPU, local AI + +======================= +ROCm CLI documentation +======================= + +ROCm CLI is a command-line tool for setting up and running local AI on AMD +GPUs, with a full-screen TUI dashboard for GPU telemetry, model serving, and +chat. + +It ships as a single prebuilt binary for Linux and Windows (x86_64), needs no +Python, Rust, or existing ROCm install, and includes inference engine +adapters for Lemonade and vLLM. + +.. important:: + + **Tech Preview:** This software is provided as-is, without warranty or + guarantee of stability. APIs, commands, and behavior may change without + notice. Intended for experimentation and early feedback only. + +The ROCm CLI public repository is located at +`ROCm/rocm-cli `_. + +.. grid:: 2 + :gutter: 3 + + .. grid-item-card:: Demos + + * :doc:`See ROCm CLI in action ` + + .. grid-item-card:: Install + + * :doc:`Installing ROCm CLI ` + + .. grid-item-card:: Getting started + + * :doc:`Getting started with ROCm CLI ` + + .. grid-item-card:: Commands + + * :doc:`Command reference ` diff --git a/docs/rocm-docs/install/installation.md b/docs/rocm-docs/install/installation.md new file mode 100644 index 0000000000..5f1cb3dc86 --- /dev/null +++ b/docs/rocm-docs/install/installation.md @@ -0,0 +1,26 @@ + + +# Installing ROCm CLI + +ROCm CLI ships as a single prebuilt binary. Platform support: + +```{include} ../../../README.md +:start-after: "" +:end-before: "" +``` + +Live dashboard telemetry requires Linux or WSL2 (see +[Interactive interfaces](../getting-started.md#interactive-interfaces)). vLLM +serving is Linux or WSL2 only (see `docs/vllm.md`). + +```{include} ../../../README.md +:start-after: "## Installation" +:end-before: "See [CONTRIBUTING.md]" +``` + +See [Contributing](../about/contributing.md) for the full development setup, test +commands, and commit-signing requirements. diff --git a/docs/rocm-docs/sphinx/_toc.yml.in b/docs/rocm-docs/sphinx/_toc.yml.in new file mode 100644 index 0000000000..7534a1eaa8 --- /dev/null +++ b/docs/rocm-docs/sphinx/_toc.yml.in @@ -0,0 +1,19 @@ +root: index +subtrees: + - caption: Demos + entries: + - file: demos + title: See ROCm CLI in action + - caption: Install + entries: + - file: install/installation + - caption: Getting started + entries: + - file: getting-started + - caption: Commands + entries: + - file: commands + - caption: About + entries: + - file: about/contributing + - file: about/license diff --git a/docs/rocm-docs/sphinx/requirements.txt b/docs/rocm-docs/sphinx/requirements.txt new file mode 100644 index 0000000000..d330c976ac --- /dev/null +++ b/docs/rocm-docs/sphinx/requirements.txt @@ -0,0 +1 @@ +rocm-docs-core==1.40.0