Skip to content

Updating Docs as ltorres6 has pushed changes to main #17

Updating Docs as ltorres6 has pushed changes to main

Updating Docs as ltorres6 has pushed changes to main #17

name: Docs
run-name: "Updating Docs as ${{ github.actor }} has pushed changes to main"
on:
push:
branches:
- main
jobs:
docs:
runs-on: ubuntu-latest
steps:
- run: echo "🎉 The job was automatically triggered by a ${{ github.event_name }} event."
- run: echo "🐧 This job is now running on a ${{ runner.os }} server hosted by GitHub!"
- run: echo "🔎 The name of your branch is ${{ github.ref }} and your repository is ${{ github.repository }}."
- name: Check out repository code
uses: actions/checkout@v3
- run: echo "💡 The ${{ github.repository }} repository has been cloned to the runner."
- run: echo "🖥️ The workflow is now ready to test your code on the runner."
- name: Install Python 3.10
uses: actions/setup-python@v4
with:
python-version: '3.10'
- name: Install dependencies
run: |
python -m pip install --upgrade pip
python -m pip install -e .[tests,docs]
- name: Update Sphinx htmls
run: |
make html
working-directory: docs
- name: Publish to gh-pages
uses: peaceiris/actions-gh-pages@v3
if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/main' }}
with:
publish_branch: gh-pages # default: gh-pages
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: docs/build/html/
force_orphan: true
- run: echo "Status of job = ${{ job.status }}."