Repository navigation
Fill out the documentation - #268
Merged
Merged
Conversation
- Update main landing page - Build Getting Started page - Placeholder for User Guide, API Ref, and Contributor Guide
Member
|
yay 🎉 I love this so much. I'm not sure why the style checks fail on CI but pass pre-commit. Perhaps we should simply run pre-commit in CI. I have a fix for the flake8 errors in this PR: #267 |
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 uses sphinx with the
pydata_sphinx_themefor styling.The goal for this first cut is correct documentation covering most of the library to get users started. More work is expected in the future to cover all the corner cases, but we can't let perfection become the enemy of progress.