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.
Overview
This PR adds a
/docs
directory with content generated using MkDocs which is becoming something of a standard in the py community. MkDocs is a pleasure to work with, and I hope encourages contributors to improve the documentation.The goal is to deploy this documentation on https://readthedocs.org/.
I've added a file structure and tree based on the Diátaxis. I am by no means an expert in this framework, but the basic idea of separating different content based on the needs of the reader makes a lot of sense and seems tractable for us to maintain.
It is obviously quite sparse at the moment, but one has to start somewhere. I've copied some of the information in the README into these docs, into where I thought were the appropriate sections. If we're happy with these docs, and we get them deployed to readthedocs, then we can remove some of that duplicated information from the README and just link to the new docs.
Screenshots
Here are some examples of what it looks like:
The home page that will show on first load:
Some of the tutorial content from our existing README: