Add material to documentation #139
Draft
Conversation
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
This is lifted from the manuscript and converted into restructured text (if I have that correct).
|
Does anybody know if / how we can see unmerged documentation changes? We should probably document that in the maintainers section! |
…ation Need to deal with the restructured text formatting!
|
There isn't an easy way to look at the PR without building locally. We could move to ReadTheDocs which provides a way to preview documentation in PRs: https://docs.readthedocs.com/platform/latest/pull-requests.html |
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.
We've been asked to shorten the JOSS manuscript. I think the best bet is to remove the "how this works" material from the manuscript and put it into the documentation. This PR captures that work.
Thus far, this is just text lifted from the manuscript and converted into restructured text (if I have that correct).