Skip to content

Set up basic documentation - #45

Open
leburgel wants to merge 2 commits into
Jutho:masterfrom
leburgel:lb/setup_docs
Open

Set up basic documentation#45
leburgel wants to merge 2 commits into
Jutho:masterfrom
leburgel:lb/setup_docs

Conversation

@leburgel

Copy link
Copy Markdown
Contributor

While the README has had a very helpful update recently, I think it would be good to additionally have some basic library documentation which at least collects all the docstrings. In particular, this would make it possible to directly refer to OptimKit.jl methods using DocumenterInterLinks.jl, which would be very helpful in MPSKit.jl and PEPSKit.jl.

I checked the build locally, but the github pages will have to be set up after merging to actually get things published.

@codecov-commenter

codecov-commenter commented Aug 12, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 82.31%. Comparing base (82b4306) to head (1c8aba0).

Additional details and impacted files
@@           Coverage Diff           @@
##           master      #45   +/-   ##
=======================================
  Coverage   82.31%   82.31%           
=======================================
  Files           8        8           
  Lines         752      752           
=======================================
  Hits          619      619           
  Misses        133      133           

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

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants