Skip to content

Make documentation#21

Merged
mdpiper merged 27 commits intodevelopfrom
mdpiper/make-docs
Sep 21, 2020
Merged

Make documentation#21
mdpiper merged 27 commits intodevelopfrom
mdpiper/make-docs

Conversation

@mdpiper
Copy link
Copy Markdown
Member

@mdpiper mdpiper commented Sep 10, 2020

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

Todo:

  • Write a long-form example of wrapping bmi-example-c
  • Build the docs through Travis CI
  • Set up readthedocs site

@mcflugen
Copy link
Copy Markdown
Member

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

@mcflugen
Copy link
Copy Markdown
Member

@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
Copy link
Copy Markdown
Member Author

mdpiper commented Sep 11, 2020

@mcflugen Thank you!

@mdpiper
Copy link
Copy Markdown
Member Author

mdpiper commented Sep 11, 2020

@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.

@mdpiper mdpiper changed the title Make user documentation Make documentation Sep 11, 2020
@mcflugen
Copy link
Copy Markdown
Member

@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.

This includes a Python script showing how to call the *heat* model
in *pymt*.
@mdpiper mdpiper merged commit 297ee6d into develop Sep 21, 2020
@mdpiper mdpiper deleted the mdpiper/make-docs branch September 21, 2020 18:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants