csdms / babelizer

Transform BMI-wrapped models into Python packages
https://babelizer.readthedocs.io
MIT License
4 stars 3 forks source link

Make documentation #21

Closed mdpiper closed 3 years ago

mdpiper commented 3 years ago

This PR adds user and API documentation, written with Sphinx, for the babelizer.

Todo:

mcflugen commented 3 years ago

@mdpiper I've added a docs build stage to the Travis CI that builds the docs and set up a readthedocs site.

mcflugen commented 3 years ago

@mdpiper I've added a few sections based on top-level docs (e.g. authors, changelog, etc.) and brought the contents of the readme file into the docs.

mdpiper commented 3 years ago

@mcflugen Thank you!

mdpiper commented 3 years ago

@mcflugen I'd like to make a long-form example of wrapping bmi-example-c. Should it go in the README (in Examples), or in a separate file?

It would make the README kinda long.

mcflugen commented 3 years ago

@mdpiper Probably in a separate document. The README is, as you say, already on the long side and is only intended to give a quick overview anyway.