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

Add docs folder #4963

Merged
merged 20 commits into from
Aug 28, 2024
Merged

Add docs folder #4963

merged 20 commits into from
Aug 28, 2024

Conversation

BeastyBlacksmith
Copy link
Member

@BeastyBlacksmith BeastyBlacksmith commented Jul 13, 2024

Description

This adds the docs folder formerly on PlotDocs.jl here, so we have the generating code more easily in sync with the codebase.

The documentation still should be deployed to PlotDocs.jl, se we don't increase the repository size to an unreasonable amount.

TODO:

  • update source to be compatible with Documenter 1.x

Attribution

Copy link

codecov bot commented Jul 13, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 87.06%. Comparing base (617b8aa) to head (7141f24).
Report is 2 commits behind head on v2.

Additional details and impacted files
@@           Coverage Diff           @@
##               v2    #4963   +/-   ##
=======================================
  Coverage   87.06%   87.06%           
=======================================
  Files          51       51           
  Lines        5999     5999           
=======================================
  Hits         5223     5223           
  Misses        776      776           

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

@isentropic
Copy link
Member

Could you clarify a bit more why is this needed? I do not understand that much

@BeastyBlacksmith
Copy link
Member Author

It makes contributing and updating the documentation easier when you can do it in the same PR

@isentropic
Copy link
Member

Oh just for 2.0 right?

@BeastyBlacksmith
Copy link
Member Author

thats right

@BeastyBlacksmith BeastyBlacksmith added this to the v2.0 milestone Jul 18, 2024
@BeastyBlacksmith BeastyBlacksmith merged commit 8bb247a into v2 Aug 28, 2024
9 of 14 checks passed
@BeastyBlacksmith BeastyBlacksmith deleted the bbs/docs branch August 28, 2024 15:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants