Olas Stack Developer Documentation

This repository aggregates the documentation of all the Olas ecosystem products.

Requirements

• Python >= 3.10
• Poetry >= 1.1.12

Usage

Initial Setup

git submodule update --init --recursive
poetry install --no-root

Serve Documentation Locally

Option 1: Using poetry run (works with all Poetry versions)

poetry run tox -e docs-serve

Option 2: Activate virtual environment first

For Poetry 2.0+:

source $(poetry env info --path)/bin/activate
tox -e docs-serve

For Poetry 1.x:

poetry shell
tox -e docs-serve

Build Documentation

poetry run tox -e docs

Release process

A check in the github actions ensures that every PR is merged with the latest version of the submodules.

1. If you only need to update a submodule (see an example here):

   • Branch: chore/update-submodules-vX.Y.Z
   • Title: "Update submodules"
   • Contents: Submodules point to its latest release. The command make prepare-release updates all the submodules to their latest released tag.
   • Approval: The PR should be verified and approved by each submodule author.

2. Release PR (see an example here):

   • Branch: feat/release-X.Y.Z
   • Title: "Prepare for release vX.Y.Z"
   • Contents: Update file HISTORY.md with the correct versions of the submodules or any other relevant change.

   Notes:

   • Occasionally, Step 1 can be merged into Step 2 above. That is, a single PR "Update submodules & Prepare for release vX.Y.Z".
   • Since this repository aggregates several submodules that might be updated independently, the versioning of this repository follows the convention of using version number of Open Autonomy repository. Updates of this repository between releases of Open Autonomy will append a number starting at .1 (for example, v0.13.0**.1**, v0.12.1.post4**.1**, etc.)

3. Create release (see an example here):

   • Tag: vX.Y.Z
   • Title: vX.Y.Z
   • Contents: Latest entry in HISTORY.md

4. The release workflow will be triggered automatically upon creating the release. It will build and deploy the documentation to the GitHub pages.