SwarmUS-doc

This repo stores all the user documentation for the SwarmUS project.

The documentation is served via Github Pages, you can access it here

Using this repo

The documentation website is built using MkDocs with the mkdocs-material theme.

Setting up you local environment

Prerequisites:

• Python 3.x
• Pip

Install the required tools and dependencies. This will install MkDocs and the Material theme.

pip install -r requirements.txt

Serving locally

To launch the website locally, run

mkdocs serve

Building and Deploying

Deploying to GitHub Pages is done by using this command:

mkdocs gh-deploy

Writing Some Documentation

When adding a new page, make sure to route the file in the mkdocs.yml file, under nav. MkDocs will generate the documentation using the provided hierarchy. New pages should all be added under the sections folder.

Automatic Deployments

A GitHub Actions pipeline will automatically deploy the documentation when there is a new push in the master branch.