-
Notifications
You must be signed in to change notification settings - Fork 1
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
Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅
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
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
Makes sense, thanks. Should we update https://github.com/ITensor/ITensorPkgSkeleton.jl/blob/main/docs/make.jl correspondingly (I see |
Agreed. |
I'd be good with |
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. |
What do you think of "Reference" as opposed to "Library"? |
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 |
Agreed. |
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.