docs-guide-test.yml

name: Test Docs Guide
on:
  push:
    branches:
      - main
      - '1.*'
  pull_request:

permissions:
  contents: write

jobs:
  build-and-test:
    name: Docs Guide Build
    concurrency: ci-${{ github.ref }} # Recommended if you intend to make multiple deployments in quick succession.
    runs-on: ubuntu-latest
    if: github.repository_owner == 'Qiskit'
    steps:
      - name: Checkout
        uses: actions/checkout@v3
      - name: Set up Python 3.9
        uses: actions/setup-python@v4
        with:
          python-version: '3.9'
      - name: Install Non-Python Dependencies
        run: sudo apt-get install -y pandoc graphviz
      - name: Install tox
        run: python -m pip install -U tox
      - name: Test Code Examples
        run: tox run -e doctest
      - name: Build Docs Guide
        run: tox run -e docs-guide
      - name: Compress Artifacts
        run: |
          mkdir artifacts
          tar -zcvf html_docs.tar.gz docs_guide/_build/html
          mv html_docs.tar.gz artifacts/.
      - uses: actions/upload-artifact@v2
        with:
          name: html_docs
          path: artifacts