I tried to be as consistent and clear as possible with the documentation, making it easy to navigate and understand, though I'm happy to make adjustments to the structure. Pulled inspiration from the pybaseball, nba_api, and Pandas documentation for various parts of it. I checked how each of the files would appear online using this markdown preview site.
I also updated the README to no longer have the usage section and instead point to the new docs folder, and put Python version 3.8 as the oldest supported version instead of 3.5.
This documentation won't be 100% relevant until we get the docstrings and stats file branches pulled into master, fwiw.
I tried to be as consistent and clear as possible with the documentation, making it easy to navigate and understand, though I'm happy to make adjustments to the structure. Pulled inspiration from the pybaseball, nba_api, and Pandas documentation for various parts of it. I checked how each of the files would appear online using this markdown preview site.
I also updated the README to no longer have the usage section and instead point to the new docs folder, and put Python version 3.8 as the oldest supported version instead of 3.5.
This documentation won't be 100% relevant until we get the docstrings and stats file branches pulled into master, fwiw.