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 using DocumenterInterLinks for ManifoldsBase.jl #366

Merged
merged 8 commits into from
Mar 15, 2024

Conversation

kellertuer
Copy link
Member

@kellertuer kellertuer commented Mar 14, 2024

This is still a bit WIP, since we have to

  • check all occurrences of .io/ManifoldsBase.jl/ in the docs and check whether to replace that with an interlink (probably in all cases besides the Readme.md
  • figure out how to handle that in the .qmd files

But in general it seems to work really nice and smoothly, following the ideas mentioned at http://juliadocs.org/DocumenterInterLinks.jl/stable/syntax/

Copy link

codecov bot commented Mar 14, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 99.73%. Comparing base (a0cb692) to head (39f7921).

Additional details and impacted files
@@           Coverage Diff           @@
##           master     #366   +/-   ##
=======================================
  Coverage   99.73%   99.73%           
=======================================
  Files          73       73           
  Lines        6822     6822           
=======================================
  Hits         6804     6804           
  Misses         18       18           

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

@kellertuer kellertuer marked this pull request as ready for review March 15, 2024 11:07
@kellertuer kellertuer added the Ready-for-Review A label for pull requests that are feature-ready label Mar 15, 2024
@kellertuer
Copy link
Member Author

This should be finished so far. I think since this is just a technical update, it should maybe not get its own release but be part of the next one.

Changelog.md Outdated Show resolved Hide resolved
@mateuszbaran
Copy link
Member

LGTM.

Do you prefer do merge this one first or the sectional curvature one?

Co-authored-by: Mateusz Baran <mateuszbaran89@gmail.com>
@kellertuer
Copy link
Member Author

Yes, I think merging this one first has two advantages

  • you can use the same new scheme directly to link to the sectional curvature as well
  • merging this into your PR hopefully also fixes the documentation run there.

@kellertuer kellertuer merged commit 7f84436 into master Mar 15, 2024
15 checks passed
@kellertuer kellertuer deleted the kellertuer/DocumenterInterLinks branch May 4, 2024 17:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Ready-for-Review A label for pull requests that are feature-ready
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants