Begin reworking the Usage page in the docs #213
Merged
Conversation
This file contains 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
selipot
approved these changes
Jul 7, 2023
There was a problem hiding this comment.
Looks good, thank you for starting this.
The distinct uses of "ragged-array" and "ragged array" make sense but are a bit tricky.
Is there a way to render the documentation from a PR branch?
Should we make a bullet list for the desired changes for the documentation: add graphics, change template?
|
I also changed the theme to sphinx-book-theme in this PR because it was easy. Let's add graphics in a separate PR. |
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.
I started reworking the Usage page of the docs. It will show how to access available ragged-array datasets, how to run some analysis functions and what's available, and how can custom datasets be adapted to a ragged-array structure.
Closes #122.