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

Switch to Documenter v1 #322

Merged
merged 1 commit into from
Jan 3, 2024
Merged

Switch to Documenter v1 #322

merged 1 commit into from
Jan 3, 2024

Conversation

gdalle
Copy link
Member

@gdalle gdalle commented Dec 15, 2023

Documenter v1 brings lots of improvements and more safety checks by default.
The only change required for the build to succeed was adding a docs page for the Graphs.Test submodule by @simonschoelly, while specifying that it is not public API.

Copy link

codecov bot commented Dec 15, 2023

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (da6f801) 97.26% compared to head (06fadd2) 97.26%.

Additional details and impacted files
@@           Coverage Diff           @@
##           master     #322   +/-   ##
=======================================
  Coverage   97.26%   97.26%           
=======================================
  Files         115      115           
  Lines        6795     6795           
=======================================
  Hits         6609     6609           
  Misses        186      186           

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

@gdalle gdalle requested a review from aurorarossi December 18, 2023 15:58
@gdalle gdalle added the enhancement New feature or request label Dec 21, 2023
Copy link
Contributor

@hyrodium hyrodium left a comment

Choose a reason for hiding this comment

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

LGTM!

@gdalle gdalle removed the request for review from aurorarossi January 3, 2024 08:40
@gdalle gdalle merged commit 34b44d0 into master Jan 3, 2024
9 of 12 checks passed
@gdalle gdalle deleted the gd/documenter1 branch January 3, 2024 08:41
@simonschoelly
Copy link
Member

Why should Graphs.Test not be part of the public api?

@gdalle
Copy link
Member Author

gdalle commented Jan 3, 2024

That's a good point. I wanted this PR to focus on the Documenter change, without introducing API commitments that we may not want to honor. That's why I specified that it was internal for the time being, but if we deem Graphs.Test to be stable enough, we can definitely make it public

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

Successfully merging this pull request may close these issues.

3 participants