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

Cross references with DocumenterInterLinks #33

Merged
merged 6 commits into from
Apr 4, 2024

Conversation

patrickersing
Copy link
Contributor

This PR introduces DocumenterInterLinks.jl to handle external references to Trixi.jl in the docs and should fix #32.

@patrickersing patrickersing added the documentation Improvements or additions to documentation label Mar 30, 2024
@patrickersing patrickersing marked this pull request as ready for review March 30, 2024 12:09
Copy link

codecov bot commented Mar 30, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 99.22%. Comparing base (43caf4f) to head (6c4ba41).

Additional details and impacted files
@@           Coverage Diff           @@
##             main      #33   +/-   ##
=======================================
  Coverage   99.22%   99.22%           
=======================================
  Files          45       45           
  Lines        1680     1680           
=======================================
  Hits         1667     1667           
  Misses         13       13           

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

Copy link
Member

@andrewwinters5000 andrewwinters5000 left a comment

Choose a reason for hiding this comment

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

LGTM! I just left one question. It was nice that this was easy to setup. Thanks for the suggestion @sloede

src/equations/shallow_water_multilayer_1d.jl Show resolved Hide resolved
@andrewwinters5000 andrewwinters5000 merged commit a76d1ba into trixi-framework:main Apr 4, 2024
9 checks passed
@patrickersing patrickersing deleted the crossref branch April 4, 2024 07:37
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.

Cross references to Trixi.jl
2 participants