From 6fb86c7928adeb4adc0dafcfa2ac6bacb11537ab Mon Sep 17 00:00:00 2001 From: Dalena Date: Thu, 24 Oct 2024 16:07:58 -0400 Subject: [PATCH 1/2] fix: install dependencies --- .github/workflows/docs.yaml | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/.github/workflows/docs.yaml b/.github/workflows/docs.yaml index 70f15475..aa0d674d 100644 --- a/.github/workflows/docs.yaml +++ b/.github/workflows/docs.yaml @@ -23,6 +23,11 @@ jobs: with: python-version: "3.10" + - name: Install Dependencies + run: | + python -m pip install --upgrade pip + pip install .[doc] + - name: Ape Docs uses: apeworx/sphinx-ape@main with: From d257855562e132e82e0c4bf1b83ee26bfb7d5c0c Mon Sep 17 00:00:00 2001 From: Dalena Date: Thu, 24 Oct 2024 16:21:23 -0400 Subject: [PATCH 2/2] docs: add descriptions for cli --- docs/commands/cluster.rst | 1 + docs/commands/run.rst | 1 + docs/index.rst | 4 ++++ 3 files changed, 6 insertions(+) diff --git a/docs/commands/cluster.rst b/docs/commands/cluster.rst index af32af68..99b4bb31 100644 --- a/docs/commands/cluster.rst +++ b/docs/commands/cluster.rst @@ -1,5 +1,6 @@ Cloud Platform ============== +CLI commands for interacting with the Silverback Platform. .. click:: silverback._cli:login :prog: silverback login diff --git a/docs/commands/run.rst b/docs/commands/run.rst index 13d396cf..4d11b86c 100644 --- a/docs/commands/run.rst +++ b/docs/commands/run.rst @@ -1,5 +1,6 @@ Local Development ================= +CLI commands for local development of running Silverback bots and task workers. .. click:: silverback._cli:run :prog: silverback run diff --git a/docs/index.rst b/docs/index.rst index b5590661..d43cbeec 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -1 +1,5 @@ .. dynamic-toc-tree:: + :plugin-prefix: ape_ + :commands: + - run + - cluster \ No newline at end of file