Birdhouse Docs

This is the Birdhouse documentation for the new generation of birds with pygeoapi (ogcapi-processes).

The legacy docs for birds with PyWPS (Web Processing Service) can be found on GitHub and on ReadTheDocs.

Birds are services providing processes for specific thematic subjects. For example to access climate data or to run a cyclone tracking tool. The services are using pygeoapi from the GeoPython project.

Birdhouse provides tools (cockiecutter-template, birdy client, docker, ...) to make it easier to build, use and deploy new thematic birds.

Build the docs

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

Adding new pages

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.

Convert rst to 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.