doc.yml

name: deploy-book

# Only run this when the master branch changes
on:
  push:
    branches:
    - main

# This job installs dependencies, builds the book, and pushes it to `gh-pages`
jobs:
  deploy-book:
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@v2

    # Install dependencies
    - name: Set up Python 3.8
      uses: actions/setup-python@v2
      with:
        python-version: 3.8

    - name: Install dependencies
      run: |
        pip install .
        pip install sphinx
        pip install jupyter-book

    - name: Sphinx APIDoc
      run: |
        sphinx-apidoc -f -o jupyter-book/_api/ cp2kdata/ --separate

    # Build the book
    - name: Build the book
      run: |
        jupyter-book build jupyter-book/

    # Push the book's HTML to github-pages
    - name: GitHub Pages action
      uses: peaceiris/actions-gh-pages@v3.6.1
      with:
        github_token: ${{ secrets.GITHUB_TOKEN }}
        publish_dir: jupyter-book/_build/html