Skip to content
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

Merged
merged 30 commits into from
Oct 16, 2021
Merged

<WIP> Add docs build & update documentation #2

merged 30 commits into from
Oct 16, 2021

Conversation

lwasser
Copy link
Owner

@lwasser lwasser commented Oct 16, 2021

This is a DRAFT start of rebuilding the docs.

  • cleanup make build and ensure api docs are correctly building
  • fix envt file / requirements file to ensure all are working
  • fix TOC to ensure docs are easy to follow

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.

@lwasser lwasser changed the title Docs build <WIP> Docs build Oct 16, 2021
@lwasser lwasser changed the title <WIP> Docs build <WIP> Add docs build & update documentation Oct 16, 2021
@lwasser
Copy link
Owner Author

lwasser commented Oct 16, 2021

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.

@lwasser lwasser marked this pull request as ready for review October 16, 2021 15:14
@lwasser lwasser merged commit a625cc8 into master Oct 16, 2021
@lwasser
Copy link
Owner Author

lwasser commented Oct 16, 2021

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant