I went ahead and added some more documentation. This PR's main purpose is to add a Setup and a Usage section to the documentation, but I also added / changed some other things:
I added more content to README.rst, including some basic usage examples, taken mostly from the current README.rst. I originally tried to convert the entire current Markdown README to RST, but that turned out to not really work.
I made small changes to setup.py. Namely, the License qualifier had GPLv3, but looking at the short 'MIT' license specifier there and in this repo, I assume you forgot to replace this in 9148b649a086d6ae77378ed708dfdd52dfcf2a42. I also made it read the contents of README.rst as the long_description, resulting in it being displayed nicely on PyPI. Currently, this shows nothing. I tested this on TestPyPi.
I think you had a typo in the README, suggesting {'sample@gmail.com', 'Sam'} for aliasing recipients, so I changed the , to a :
About the new documentation itself: It should be fairly similar to the current README, giving people a overview for installation and usage, so the table of contents currently look like this:
If there is stuff that I should add / change / remove, please let me know. 😄
Coverage increased (+1.2%) to 53.386% when pulling d460b0b852965980dfc7aed5c0bd7369c4cd3d56 on Volcyy:doc-overhaul into 5d2f49c4a3c4f186039e479524340482b61856a8 on kootenpv:master.
Wow, thanks so much for taking the time to improve it allover. It really could use... Including reorganizing some sections!
When I get back later I'll deploy to pypi!
I went ahead and added some more documentation. This PR's main purpose is to add a
Setup
and aUsage
section to the documentation, but I also added / changed some other things:README.rst
, including some basic usage examples, taken mostly from the currentREADME.rst
. I originally tried to convert the entire current Markdown README to RST, but that turned out to not really work.setup.py
. Namely, theLicense
qualifier hadGPLv3
, but looking at the short'MIT'
license specifier there and in this repo, I assume you forgot to replace this in 9148b649a086d6ae77378ed708dfdd52dfcf2a42. I also made it read the contents ofREADME.rst
as thelong_description
, resulting in it being displayed nicely on PyPI. Currently, this shows nothing. I tested this on TestPyPi.{'sample@gmail.com', 'Sam'}
for aliasing recipients, so I changed the,
to a:
About the new documentation itself: It should be fairly similar to the current README, giving people a overview for installation and usage, so the table of contents currently look like this:
If there is stuff that I should add / change / remove, please let me know. 😄