From c750635329890590d7b77e47b9b84168309c7a98 Mon Sep 17 00:00:00 2001 From: Eric Weber Date: Fri, 6 Dec 2024 16:42:26 -0800 Subject: [PATCH] docs: ci-generated docs usage --- CONTRIBUTING.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 2acd001d..cae41892 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -40,6 +40,16 @@ of the file `docs/docs_utils.py` which is responsible for generating the part of http://localhost:8000 +### Use CI-generated docs + +The GitHub workflows automatically generate the docs and save them as artifacts. These can be accessed from the Artifacts section of the worfklow view (as [documented here](https://docs.github.com/en/actions/managing-workflow-runs-and-deployments/managing-workflow-runs/downloading-workflow-artifacts)). + +To view them: + +1. Download the artifact labeled `Docs`. +1. Extract the contents of the resulting `Docs.zip` file. +1. Open the `index.html` file in a browser. + ## Running the tests Same as before, using `uv` means that you don't need to install anything. Just run