Skip to content

Commit

Permalink
docs: ci-generated docs usage
Browse files Browse the repository at this point in the history
  • Loading branch information
rcwbr authored Dec 7, 2024
1 parent 8af33b5 commit c750635
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit c750635

Please sign in to comment.