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

Convert docs to read the docs #16

Merged
merged 2 commits into from
Mar 8, 2024

Conversation

catanzaromj
Copy link
Contributor

@catanzaromj catanzaromj commented Mar 7, 2024

This PR introduces a read the docs documentation build rather than github pages. If this is desired, you can remove the github pages build in a future PR once everything is working and in place. The docs based off this PR can be viewed here if you have access to scikit-tda on RTD. If you don't, well they look great! All of the notebooks are compiling and the API links working. If you pass along your RTD username, I can add you to the RTD admin page and you can view it yourself.

I added a docs section to setup.py rather than a docs/requirements.txt file. I prefer this style, since it's easer for a user to install these additional requirements when they install the package (if they desire). If you prefer the latter, I can switch it over.

Copy link

codecov bot commented Mar 7, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 72.61%. Comparing base (4215778) to head (a59fa87).

Additional details and impacted files
@@           Coverage Diff           @@
##           master      #16   +/-   ##
=======================================
  Coverage   72.61%   72.61%           
=======================================
  Files          10       10           
  Lines        1048     1048           
  Branches      189      189           
=======================================
  Hits          761      761           
  Misses        268      268           
  Partials       19       19           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@catanzaromj catanzaromj self-assigned this Mar 7, 2024
@catanzaromj
Copy link
Contributor Author

If this all seems good, then we can host the docs at dreimac.scikit-tda.org if you'd like, in line with the other scikit-tda projects. We can also link to DREiMac from the main scikit-tda docs as well.

@catanzaromj catanzaromj marked this pull request as ready for review March 7, 2024 13:28
Copy link
Collaborator

@LuisScoccola LuisScoccola left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me, thanks!

@catanzaromj catanzaromj merged commit 41b2a21 into scikit-tda:master Mar 8, 2024
16 checks passed
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.

2 participants