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.
As there were no docs for the project apart from the README, I have created
basic draft sphinx documentation. It is partially based on including sections
from the README, but I have also added some additional information in more
structured way.
The questions are where to host it and if the README should be kept in the
current extensive form or if it should be shortened and the rest just kept
in the docs. What is the right balance between the README and the docs?
I temporarily hosted the draft docs on PythonAnywhere so it could be quickly viewed rendered.
The choice of theme and other bikeshedding can be done later, but I think
it's a good start.