From 8b4b51d1452077ebbf45dba6d3b26aca982c121f Mon Sep 17 00:00:00 2001 From: lochhh Date: Mon, 4 Nov 2024 16:52:38 +0000 Subject: [PATCH] Add clone repo as prereq in building docs locally --- src/contributor/index.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/src/contributor/index.md b/src/contributor/index.md index 6efc669..fc1e389 100644 --- a/src/contributor/index.md +++ b/src/contributor/index.md @@ -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