Skip to content

Set up basic documentation - #45

Merged
Jutho merged 3 commits into
Jutho:masterfrom
leburgel:lb/setup_docs
Aug 26, 2026
Merged

Set up basic documentation#45
Jutho merged 3 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 (e0487db).

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.

@leburgel

Copy link
Copy Markdown
Contributor Author

@Jutho, does this seem reasonable to you?

Comment thread docs/src/index.md Outdated
Comment thread docs/src/index.md Outdated
@Jutho

Jutho commented Aug 25, 2026

Copy link
Copy Markdown
Owner

Thanks for the reminder; I am still trying to catch up on all the PRs since my holidays. Other than the two small comments, this looks good to me.

@Jutho
Jutho merged commit e18044d into Jutho:master Aug 26, 2026
10 checks passed
@leburgel
leburgel deleted the lb/setup_docs branch August 26, 2026 11:47
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.

3 participants