How to contirbute to this documentation

Clone the docs repo from GitHub:

git clone https://github.com/bird-house/birdhouse2-docs.git

cd birdhouse2-docs

Create conda environment:

conda env create
conda activate birdhouse2-docs

Build the docs:

mkdocs build

# html output is in folder site/

Or serve the docs for your browser:

mkdocs serve

Please read the docs at mkdocs and also at mkdocs-material.

There is a user guide on mkdocs describing how to add new pages with markdown.

You can convert rst files to markdown using pandoc.

pandoc tutorial.rst -t markdown -o tutorial.md

Probably some edits are neccessary after the conversion.