Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
docs
.editorconfig
.gitignore
CONTRIBUTING.md
README.md
mkdocs.yml

README.md

ORR Documentation source

The master branch of this repository contains the source of the ORR documentation.

The documentation source is written in plain text files using Markdown syntax.

We use MkDocs tool for the site generation.

Your help improving this documentation is welcome!

Generation

The documentation, which is reflected at https://mmisw.org/orrdoc/, is automatically generated upon changes pushed to this repo.

In particular, the API documentation at https://mmisw.org/orrdoc/api/ is currently generated as explained here.

Local testing

Please see the MkDocs documentation if you are testing things under your local clone.