CBLE Documentation

This documentation is built with mkdocs and uses Poetry for dependency management.

Prerequisites

• Poetry
• Python ^3.11

Building

To build the site locally, just run mkdocs build and the static site will be generated in the site folder.

Deployment

This site is using versioned documentation with mike.

⚠️ To deploy a new version, merge all changes into main first

git switch main

mike deploy -t "x.x (latest)" x.x latest

mike serve

# Check to ensure generated site is good to go

git switch gh-pages

git push

git switch main

Development

Ensure you have the prerequisites installed and then run the dev server using mkdocs serve.