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

chore(docs): publish from RTD #31

Merged
merged 1 commit into from
Jan 31, 2024
Merged

chore(docs): publish from RTD #31

merged 1 commit into from
Jan 31, 2024

Conversation

jeertmans
Copy link
Owner

@jeertmans jeertmans commented Jan 31, 2024

ReadTheDocs offers two important features that GitHub pages do not:

  1. builds versioning;
  2. and build docs for PR (preview).

This is enough to motivate the migration to RTD.

I will keep a dummy GitHub pages site that redirects to RTD.

@jeertmans jeertmans added the documentation Improvements or additions to documentation label Jan 31, 2024
Copy link
Contributor

Python benchmark results:


Legend:
  Outliers: 1 Standard Deviation from Mean; 1.5 IQR (InterQuartile Range) from 1st Quartile and 3rd Quartile.
  OPS: Operations Per Second, computed as 1 / Mean

Copy link

codecov bot commented Jan 31, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (014fb25) 86.53% compared to head (6ef0b06) 86.53%.

Additional details and impacted files
@@           Coverage Diff           @@
##             main      #31   +/-   ##
=======================================
  Coverage   86.53%   86.53%           
=======================================
  Files          12       12           
  Lines         312      312           
=======================================
  Hits          270      270           
  Misses         42       42           

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

@jeertmans jeertmans merged commit 4c1a97e into main Jan 31, 2024
31 of 32 checks passed
@jeertmans jeertmans deleted the rtd branch January 31, 2024 14:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant