Skip to content

Push preview of documentation #63

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

Merged
merged 4 commits into from
Sep 5, 2024
Merged

Push preview of documentation #63

merged 4 commits into from
Sep 5, 2024

Conversation

JoshuaLampert
Copy link
Member

@JoshuaLampert JoshuaLampert commented Sep 5, 2024

It's nice to see the documentation is evolving!
I saw your question on discourse. This should push a preview of the documentation for each PR. You should be able to visit the preview by clicking on the "Details" link of the "documenter/deploy" CI job below.
I also thought it might be nice to add some more badges to the README and landing page of the docs.

@JoshuaLampert JoshuaLampert added the documentation Improvements or additions to documentation label Sep 5, 2024
@JoshuaLampert
Copy link
Member Author

It also seemed like there were some duplicate docs entries, which made building the docs fail. I fixed that by removing the integration algorithms section. If you prefer another approach, please tell me your preference, @mikeingold.

Copy link

codecov bot commented Sep 5, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 76.77%. Comparing base (d0248d3) to head (9c2a662).
Report is 2 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main      #63   +/-   ##
=======================================
  Coverage   76.77%   76.77%           
=======================================
  Files           7        7           
  Lines         353      353           
=======================================
  Hits          271      271           
  Misses         82       82           

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

@mikeingold
Copy link
Collaborator

Thanks, @JoshuaLampert!

My free time has been a bit fragmented lately, and I made the mistake of not waiting for my last PR to finish Actions before merging (“it’s just a minor update only to the docs” 🤦‍♂️). I was using those doc strings as placeholders for personalized content but hadn’t realized that duplicate @docs entries were forbidden. For now, probably best to just un-list the page as you did here.

@mikeingold mikeingold merged commit b1c4bfb into main Sep 5, 2024
13 checks passed
@mikeingold mikeingold deleted the push-preview-docs branch September 5, 2024 22:22
@mikeingold
Copy link
Collaborator

Thanks again, @JoshuaLampert! You’ve been a huge help maturing this package.

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.

2 participants