Merge pull request #2140 from microbiomedata/custom-slot-jinja #524
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
name: Auto-deployment of nmdc-schema Documentation | |
on: | |
push: | |
branches: [ main ] | |
jobs: | |
build-docs: | |
runs-on: ubuntu-latest | |
steps: | |
- name: Checkout | |
uses: actions/checkout@main | |
with: | |
fetch-depth: 0 # otherwise, you will failed to push refs to dest repo | |
- name: Set up Python 3. | |
uses: actions/setup-python@v3 | |
with: | |
python-version: 3.9 | |
- name: Install Poetry. | |
uses: snok/install-poetry@v1.3 | |
- name: Install dependencies. | |
run: poetry install -E docs | |
- name: Build and deploy documentation. | |
# Build the docs and deploy them to GitHub Pages. | |
# | |
# Note: The `make mkd-gh-deploy` command below uses the `mkd-%` target | |
# defined in `Makefile`. That target's action (i.e. recipe) | |
# strips off the `mkd-` prefix and passes the rest of the command | |
# to `$ poetry run mkdocs`, effectively translating the command | |
# below into `$ poetry run mkdocs gh-deploy`. | |
# | |
# Reference: https://www.mkdocs.org/user-guide/deploying-your-docs/ | |
# | |
run: | | |
mkdir -p docs | |
touch docs/.nojekyll | |
make gendoc | |
make mkd-gh-deploy |