Skip to content

Merge pull request #21 from RTIInternational:update-to-docs-site #40

Merge pull request #21 from RTIInternational:update-to-docs-site

Merge pull request #21 from RTIInternational:update-to-docs-site #40

name: Auto-deployment of BDCHM Documentation
on:
push:
branches:
- main
jobs:
build-docs:
runs-on: ubuntu-latest
# Grant GITHUB_TOKEN the permissions required to make a Pages deployment
permissions:
contents: write # to let mkdocs write the new docs
pages: write # to deploy to Pages
id-token: write # to verify the deployment originates from an appropriate source
steps:
- name: Checkout
uses: actions/checkout@v4
with:
fetch-depth: 0 # otherwise, you will failed to push refs to dest repo
- name: Set up Python.
uses: actions/setup-python@v5
with:
python-version: 3.9
- name: Install Poetry.
run: pipx install poetry
- name: Install dependencies.
run: poetry install -E docs
- name: Build documentation.
run: |
mkdir -p docs
touch docs/.nojekyll
make gendoc
([ ! -f docs/about.md ] && cp src/docs/about.md docs/) || true
make mkd-gh-deploy
#- name: Deploy to GitHub Pages.
# uses: actions/deploy-pages@v4