Welcome to CAREamics docs

This repository contains the source code for the CAREamics documentation website. The website is built using Zensical.

Website automation

At build time, the CI runs a script to copy the latest stable release of CAREamics into a local folder. From there on, it extracts the version number and generates the API reference pages. Finally, it edits zensical.toml with the navigation page.

How to build the pages locally

In order to build the pages locally, follow these steps:

1. Fork this repository and clone it.

2. Create a new environment and install the dependencies:

   uv sync

3. Run the script to get the latest release of CAREamics:

   bash scripts/pull_from_repos.sh

4. Generate the reference pages:

   uv run python scripts/gen_ref_pages.py --write

   --write indicates that the zensical.toml file should be updated with the API reference navigation structure.

5. Build the pages:

   zensical serve

6. Open the local link in your browser.

Note: This will not show you the versioning mechanism.

How to update the pages without any commit

This can be useful when one of the project has changed and we need to update the API doc. In such a case, use the dispatch workflow option of the CI (maintainers only).

Version release

The version release process is automated using mike in the CI. Upon pushing a new tag, the CI will build the documentation for that version the next time it is triggered.