leanprover-community/Documentation generation
Generates API documentation for your Lean project
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
Inputs
| name | description | required | default |
|---|---|---|---|
| api-docs | Set to true to build API docs alongside the rest of your documentation. (This is enabled by default but can be disabled if you are only interested in the blueprint.) | no | true |
| api_docs | DEPRECATED: Use api-docs instead | no | — |
| blueprint | Set to true to build a blueprint alongside your documentation. | no | false |
| build-page | Set to true to build the homepage using Jekyll alongside the rest of your documentation. (This is enabled by default but can be disabled if you are only interested in the API docs and/or blueprint.) | no | true |
| deploy | Set to true to deploy the built documentation (API docs and/or blueprint and/or homepage) to GitHub Pages. (This is enabled by default but can be disabled for a dry run.) | no | true |
| homepage | The folder where the Jekyll site can be found. | no | docs |
| build-args | This GitHub Action uses leanprover/lean-action to build and test the repository. This parameter determines what to pass to the build-args argument of leanprover/lean-action. | no | --log-level=warning |
| build_args | DEPRECATED: Use build-args instead | no | — |
| lake-package-directory | The directory containing the Lake package to build. This parameter is passed to the lake-package-directory argument of leanprover/lean-action. | no | . |
| lake_package_directory | DEPRECATED: Use lake-package-directory instead | no | — |
| references | Path to a BibTeX (.bib) file used for generating the references page and link formatting. | no | references.bib |
| use-github-cache | Whether to use the GitHub Actions cache to accelerate the build. Defaults to true. | no | true |
Outputs
no outputs