feat: use docgen-action for documentation generation #128
Conversation
Adds a GitHub Actions workflow that uses leanprover-community/docgen-action to build and deploy documentation. Closes leanprover#121
|
Adding @fmontesi as reviewer since he setup these docs. |
|
I'm intentionally not approving the workflow to run yet so that this doesn't accidentally builds docs here, as this currently does so for PRs. |
- Remove pull_request trigger to prevent running on PRs - Remove cron schedule (superseded by push to main) - Remove duplicate toolchain verification (handled by docgen-action)
|
Where does this publish the docs, exactly? |
|
I think it targets the repo's GitHub pages by default, so something like |
|
@leodemoura @kim-em (CC @swaratchaudhuri @barrettcw): Could we somehow set this up to write to https://lean-lang.org/cslib/doc/api (in the spirit of https://lean-lang.org/doc/api)? |
Right, the idea was to take inspiration from Mathlib and publish the documentation to https://leanprover.github.io/cslib/docs using GitHub Pages, so we'd need to set that up. A somewhat more complex alternative would be to set up a separate docs repo like mathlib4_docs. |
|
We do have that for now, that's where the doc is currently produced. Check out the code at https://github.com/cs-lean/cs-lean.github.io. It outputs to https://cs-lean.github.io/ |
3 participants
Uses leanprover-community/docgen-action to build & deploy docs.
Closes #121