GitHub Action to Build Documentation for a Common Lisp Library¶
This is a Github Action can be used to build docs and update
gh-pages branch used to
host static site using GitHub Pages.
It should be used after the setup-lisp action.
What this action does for you?¶
It runs docs-builder to build
If any there are any changes, it uploads them into the
A typical usage¶
Here is how a minimal GitHub Workflow might look like.
.github/workflows/docs.yml file with following content:
name: 'Docs' on: # This will run tests on pushes # to master branch and every monday: push: branches: - 'main' - 'master' schedule: - cron: '0 10 * * 1' jobs: build-docs: runs-on: ubuntu-latest env: LISP: sbcl-bin steps: - uses: actions/checkout@v1 - uses: 40ants/setup-lisp@v1 - uses: 40ants/build-docs@v1 with: asdf-system: my-system
The part, corresponding to an action call is:
- uses: 40ants/build-docs@v1 with: asdf-system: my-system
Here we provided a system name
action will figure out how to build it docs, because
it uses smart guesser from
You should check if the documentation builder is supported
docs-builder and if not, you can easily to add this support.
Add more documentation builders to
Vendor all dependencies, to make action more reliable and secure.