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 autodocs page to documentation #43

Merged
merged 3 commits into from
Jan 15, 2025
Merged

Conversation

lkdvos
Copy link
Collaborator

@lkdvos lkdvos commented Jan 14, 2025

Here I added the setup for including a page with all docstrings at the end of the documentation. As I would assume this is something that most packages will want to do anyways, I think it might be convenient to immediately set that up in the skeleton.

@lkdvos lkdvos requested a review from mtfishman January 14, 2025 13:04
Copy link

codecov bot commented Jan 14, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 6.02%. Comparing base (88679b0) to head (719235d).
Report is 2 commits behind head on main.

Additional details and impacted files
@@          Coverage Diff          @@
##            main     #43   +/-   ##
=====================================
  Coverage   6.02%   6.02%           
=====================================
  Files          1       1           
  Lines         83      83           
=====================================
  Hits           5       5           
  Misses        78      78           
Flag Coverage Δ
docs 0.00% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

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

@mtfishman
Copy link
Member

Makes sense, thanks. Should we update https://github.com/ITensor/ITensorPkgSkeleton.jl/blob/main/docs/make.jl correspondingly (I see reference.md lists them individually but it looks like we could just use autodocs instead)?

@lkdvos
Copy link
Collaborator Author

lkdvos commented Jan 14, 2025

Agreed.
As a side note, I made everything "Library" right now, but I honestly would prefer to call this "Index", but that conflicts with the index.md we have set up right now (which I would maybe rename to home.md instead?). I'm definitely not hung up on this, just something to consider.

@mtfishman
Copy link
Member

Agreed. As a side note, I made everything "Library" right now, but I honestly would prefer to call this "Index", but that conflicts with the index.md we have set up right now (which I would maybe rename to home.md instead?). I'm definitely not hung up on this, just something to consider.

I'd be good with ["Home" => "home.md", "Index" => "index.md"] (as long as "index.md" isn't treated as special in some other way by Documenter.jl?).

@lkdvos
Copy link
Collaborator Author

lkdvos commented Jan 14, 2025

Oh you are right, indeed Documenter.jl treats that as the landing page, I did not consider that. In that case, it's probably ok as is.

@mtfishman
Copy link
Member

What do you think of "Reference" as opposed to "Library"?

@lkdvos
Copy link
Collaborator Author

lkdvos commented Jan 14, 2025

I renamed and rebased on the latest changes. I can still bump to v0.2.2 if you prefer, but probably here it's okay to have both changes in a single patch

@mtfishman
Copy link
Member

here it's okay to have both changes in a single patch

Agreed.

@lkdvos lkdvos merged commit 9cfd842 into ITensor:main Jan 15, 2025
11 checks passed
@lkdvos lkdvos deleted the ld-docpage branch January 15, 2025 00:25
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