README.md

The Wumpy project Documentation

Documentation, guide and API reference for official Wumpy subpackages.

Setup

The documentation is written in Markdown using MKDocs. Simply install mkdocs from PyPI with PIP:

pip install mkdocs

Once that is installed run the following command to serve the documentation locally for development:

mkdocs serve

Licensing

The Wumpy project documentation is permissively licensed under one of MIT or Apache 2.0 (up to you). See the LICENSE file for more.

This decision was made to have maximum compatibility and freedom.

Contributing

Thank you for your interest in contributing. Compared to many other projects, all kinds of changes are welcomed. If you're unsure how to get started please read the Contribution Guide.