Update docs - #324
Open
vandalt wants to merge 21 commits into
Open
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
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.
The current docs page: https://sail-labs.github.io/AMICAL/ only has part of the tutorial and seemed to come from a separate branch that was not up to date. This PR aims to include all tutorials and examples in the docs, bring it up to date with the latest branch, and integrate it to GitHub workflows.
I started by merging @benjaminpope's branch to the PR branch to build on what he had already done.
Here is a breakdown of the changes:
example*.pyfile to tutorial notebookstutorial.mdtutorial to a "Getting Started" tutorial notebookmkdocstringsI have two questions about the documentation:
TestSPHEREDatabe downloaded? I could update the tutorial to point to it.