instaloader/.github/workflows/documentation.yml

name: "Documentation"

on: [push, pull_request]

jobs:
  docs:
    name: "Documentation"
    runs-on: ubuntu-latest
    steps:
      - name: "Checkout Instaloader Repository"
        uses: actions/checkout@v7
        with:
          fetch-depth: 0  # needed for building docs
          persist-credentials: false
      - name: "Setup Python"
        uses: actions/setup-python@v6
        with:
          python-version: 3.14
          cache: 'pipenv'
      - name: "Install Dependencies"
        run: |
          python -m pip install pipenv==2025.0.4
          pipenv --python `python --version | grep -Eo '3\.[0-9]+'` sync --dev
      - name: "Build Documentation"
        run: pipenv --python `python --version | grep -Eo '3\.[0-9]+'` run make -C docs html SPHINXOPTS="-W -n"
      - name: "Deploy Documentation"
        if: github.event_name == 'push' && github.ref == 'refs/heads/master'
        uses: JamesIves/github-pages-deploy-action@v4
        with:
          branch: master
          repository-name: instaloader/instaloader.github.io
          folder: docs/_build/html
          token: ${{ secrets.PAGES_DEPLOYMENT_TOKEN }}