Update docs- mostly adding quickstart #29
Merged
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.
Summary
This PR fleshes out the README with installation details, rearranges the documentation front page, adds a quickstart section, and fixes a few things that came up when writing the documentation. Notably, I added a simulation module so users don't have to import
msprime
separately. It doesn't add functionality, just creates a couple spaceprime functions.Related Issues
Fixes #8 #7 #28
Changes Made
Motivation and Context
Adds more detailed documentation and fixed a few issues that came up while working on the documentation.
How Has This Been Tested?
No tests for the documentation. Just rendered the docs and made sure they worked.
Checklist