-
Notifications
You must be signed in to change notification settings - Fork 0
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
<WIP> Add docs build & update documentation #2
Conversation
NOTE: i will want to also remove the old API reference section. then i will make the model module nice and easy to read like the client module finally look into tests. i just need to ensure nothing is getting broken - it shouldn't but i am cleaning up docstrings. |
let's test deployment now. this should deploy to gh pages if all goes well. if this works then i can do another round of cleanup, remove the old api reference pages and get the PR going. i will submit a draft now just for a start. |
This is a DRAFT start of rebuilding the docs.
CI
setup sphinx build and push to gh pages
squash commits and cleanup PR.
i'm doing some cleanup as i go of bad links, unused imports, etc.
Documentation Preview Here
http://www.leahwasser.com/stravalib/index.html
The final url of documentation will be: stravalib.github.io/ when this is merged i'll pull down my demo in my fork.