recast-docs

Documentation for RECAST.

The latest version is hosted at here.

This project is built using mkdocs.

Workflow

Clone Repository and navigate to folder

Install mkdocs

Run pip install mkdocs and pip install mkdocs-material.

Adding pages

Create a new file with the content of the new page
touch docs/xxx.md
and add it to the nav section of the mkdocs.yml file.

site_name: RECAST
site_url: https://wogra-ag.github.io/recast-docs
repo_url: https://github.com/WOGRA-AG/RECAST
nav:
  - Home: index.md
  - Xxx: xxx.md

Test site locally

Run python3 -m mkdocs serve and open a browser of your choice on http://127.0.0.1:8000/os4ml/

Deploy

To release a new Page, just push the new corresponding branch to the repository and create a merge request on the main branch.
The CI/CD Pipeline will autmatically build and deploy the new page, if the merge request gets accepted.