docs.yml

name: docs

on:
  push:
    branches: [main]
  pull_request:
    branches: [main]

jobs:
  tests:
    name: "Build docs"
    runs-on: ubuntu-latest
    steps:
      - name: Clone vplot repo
        uses: actions/checkout@v2
        with:
          fetch-depth: 0

      - name: Set up Python
        uses: conda-incubator/setup-miniconda@v2
        with:
          activate-environment: vplot
          environment-file: environment.yml

      - name: Install vplanet-private pre-release
        shell: bash -l {0}
        run: |
          python -m pip install vplanet

      - name: Run vplanet
        shell: bash -l {0}
        run: |
          for f in docs/notebooks/examples/*/vpl.in 
          do 
              pushd ${f%/*}
                  vplanet vpl.in
              popd
          done

      - name: Install vplot
        shell: bash -l {0}
        run: |
          python -m pip install -U pip
          python -m pip install -e .

      - name: Run notebooks
        shell: bash -l {0}
        run: |
          python .github/workflows/run_notebooks.py

      - name: Build the docs
        id: build
        shell: bash -l {0}
        run: |
          cd docs
          make html
          touch _build/html/.nojekyll

      - name: Publish the docs
        uses: JamesIves/github-pages-deploy-action@4.1.2
        # NOTE: Triggered only when the PR is *merged* (event_name == 'push')
        if: steps.build.outcome == 'success' && github.event_name == 'push'
        with:
          branch: gh-pages
          folder: docs/_build/html