Skip to content

Commit

Permalink
Add clone repo as prereq in building docs locally
Browse files Browse the repository at this point in the history
  • Loading branch information
lochhh committed Nov 4, 2024
1 parent a952ad6 commit 8b4b51d
Showing 1 changed file with 3 additions and 0 deletions.
3 changes: 3 additions & 0 deletions src/contributor/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -159,6 +159,9 @@ For the `aeon_acquisition` Bonsai package, the `make_acquisition_doctree.py` scr
This TOC is then used to generate the `src/reference/api/acquisition.rst` file containing the list of modules to be included in the [API reference](target-acquisition-reference).

### Building the documentation locally
To build the documentation locally, first make sure you have cloned the [`aeon_docs` repository](aeon-docs-github:).
The following commands should be run from the root directory of the repository.

Create a `conda` environment with the required dependencies and activate it:
```bash
conda create -n aeon_docs python dotnet -c conda-forge
Expand Down

0 comments on commit 8b4b51d

Please sign in to comment.