an2deg / api-docs

API documentation

Nimble API documentation

Latest version of this documentation are always available here.

If you want to contribute, you can do it in few simple steps.

1. Install Sphinx documentation generator.
2. Fork this repository and clone it locally.
3. Make your updates. We're using reStructuredText syntax, and here is good document to start with it.
4. To build documentation locally, you can use make html command in docs subfolder of this repo.
5. Commit you changes, and make a pull request. After we accept this changes — documentation will be rebuilt and updated automatically.