Skip to content

chore: add new readme #206

chore: add new readme

chore: add new readme #206

Workflow file for this run

name: docs
on:
push:
branches:
- main
jobs:
docs:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- uses: actions/setup-python@v1
with:
python-version: "3.11"
- name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install -e .
pip install -r requirements-docs.txt
pip install -e .[all]
- name: Build docs
run: |
make docs
- uses: actions/upload-artifact@v1
with:
name: DocumentationHTML
path: site/
- name: Commit documentation changes
run: |
git clone https://github.com/robcxyz/tackle.git --branch docs --single-branch gh-pages
cp -r site/* gh-pages/
cd gh-pages
touch .nojekyll
git config --local user.email "action@github.com"
git config --local user.name "GitHub Action"
git add .
git commit -m "Update documentation" -a || true
# The above command will fail if no changes were present, so we ignore
# the return code.
- name: Push changes
uses: ad-m/github-push-action@master
with:
branch: docs
directory: gh-pages
github_token: ${{ secrets.GITHUB_TOKEN }}