doc.yml

name: "Build documentation"

on:
  workflow_dispatch:
  push:
    branches:
      - main

jobs:
  build_doc:
    runs-on: ubuntu-latest
    container:
      image: texlive/texlive:latest-full
    permissions:
      contents: read # to fetch code (actions/checkout)

    steps:
      - name: Install dependencies
        run: |
          apt-get update
          DEBIAN_FRONTEND=noninteractive TZ=Etc/UTC apt-get install -y \
            make libmagic1 pandoc

      - name: Checkout
        uses: actions/checkout@v4

      - name: Checkout quokka
        uses: actions/checkout@v4
        with:
          repository: quarkslab/quokka
          path: quokka

      - name: Checkout QBinDiff
        uses: actions/checkout@v4
        with:
          repository: quarkslab/qbindiff
          path: qbindiff

      - name: Checkout python-binexport
        uses: actions/checkout@v4
        with:
          repository: quarkslab/python-binexport
          path: python-binexport

      - name: Checkout idascript
        uses: actions/checkout@v4
        with:
          repository: quarkslab/idascript
          path: idascript

      - name: Checkout python-bindiff
        uses: actions/checkout@v4
        with:
          repository: quarkslab/python-bindiff
          path: python-bindiff

      - name: Checkout Awesome-Binary-Similarity
        uses: actions/checkout@v4
        with:
          repository: SystemSecurityStorm/Awesome-Binary-Similarity
          path: Awesome-Binary-Similarity

      - name: "Set up Python"
        uses: actions/setup-python@v4
        with:
          python-version: "3.10"

      - name: "Install Python dependencies"
        run: |
          python -m pip install -r requirements.txt
          python -m pip install enum-tools[sphinx]
          python -m pip install docutils==0.20.1

      - name: "Build Sphinx Doc"
        run: make html

      - uses: actions/upload-artifact@v3
        with:
          name: doc-pages
          path: ./build/html

  deploy:
    runs-on: ubuntu-latest
    permissions:
      contents: write
    needs: build_doc

    steps:
      - name: Checkout
        uses: actions/checkout@v4

      - uses: actions/download-artifact@v3
        with:
          name: doc-pages
          path: ./build/html

      - name: "Deploy Github Pages"
        uses: JamesIves/github-pages-deploy-action@v4
        with:
          BRANCH: gh-pages
          FOLDER: ./build/html/