Set up documentation #46
Conversation
|
After the build completes, the updated documentation will be available here |
Codecov Report✅ All modified and coverable lines are covered by tests.
🚀 New features to boost your workflow:
|
| @@ -0,0 +1,33 @@ | |||
| name: Documentation Preview Cleanup | |||
There was a problem hiding this comment.
I've never seen this workflow before. Is this something standard now? Where did you find this?
There was a problem hiding this comment.
We have it in MPSKit.jl and PEPSKit.jl. It deletes the documentation preview for a PR that is pushed to the gh-pages branch if you run Documenter.deploydocs with push_preview = true. Just so the files don't pile up there if you have many PRs I think.
docs/Project.toml
Outdated
| TensorKitSectors = "13a9c161-d5da-41f0-bcbd-e1a08ae0647f" | ||
|
|
||
| [compat] | ||
| Documenter = "1.0" |
There was a problem hiding this comment.
Is there a difference with just using "1"?
There was a problem hiding this comment.
Probably not, just copied it over from somewhere else along with the make script. I'll change it.
Sets up some basic library documentation in the simplest way possible, which can then be expanded on later. Closes #45.