docs.yml

name: Docs

on:
  pull_request:
  workflow_dispatch:

permissions:
  contents: read

jobs:
  build-docs:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout
        uses: actions/checkout@v7

      - name: Set up Python
        uses: actions/setup-python@v7
        with:
          python-version: "3.12"

      - name: Install pipx and Poetry
        run: |
          python -m pip install --upgrade pip pipx
          python -m pipx ensurepath
          echo "$HOME/.local/bin" >> "$GITHUB_PATH"
          pipx install poetry

      - name: Install dependencies
        run: poetry install --no-interaction --with dev

      - name: Generate docs
        run: |
          poetry run sync-docs-readme
          poetry run generate-cli-docs
          poetry run generate-cli-man-docs
          poetry run generate-ansible-docs

      - name: Check docs
        run: |
          poetry run check-doc-links
          poetry run check-doc-links --docs-root sccfm-ansible
          poetry run check-doc-artifacts

      - name: Build Pages site
        uses: actions/jekyll-build-pages@v1
        env:
          PAGES_DISABLE_NETWORK: "true"
        with:
          source: ./docs
          destination: ./_site