Merged
Conversation
Member
|
@mdpiper I've added a docs build stage to the Travis CI that builds the docs and set up a readthedocs site. |
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. |
Member
Author
|
@mcflugen Thank you! |
Member
Author
|
@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. |
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. |
Also started the first two sections of the example.
They still need a little polish, but they work.
This includes a Python script showing how to call the *heat* model in *pymt*.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This PR adds user and API documentation, written with Sphinx, for the babelizer.
Todo: