Skip to content

Update documentation link in readme (#47) #28

Update documentation link in readme (#47)

Update documentation link in readme (#47) #28

Workflow file for this run

# Simple workflow for deploying static content to GitHub Pages
name: Deploy static content to Pages
on:
# Runs on pushes targeting the default branch
push:
branches:
- main
# Allows you to run this workflow manually from the Actions tab
workflow_dispatch:
env:
DEFAULT_PYTHON: "3.10"
# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
permissions:
contents: read
pages: write
id-token: write
# Allow one concurrent deployment
concurrency:
group: "pages"
cancel-in-progress: true
jobs:
# Single deploy job since we're just deploying
deploy:
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-22.04
steps:
- name: Checkout
uses: actions/checkout@v3
with:
fetch-depth: 0
- name: Set up Python
uses: actions/setup-python@v4
with:
python-version: ${{ env.DEFAULT_PYTHON }}
- name: Install dependencies and build docs
run: |
# Setup version
version=$(git describe --tags --abbrev=0)
echo "__version__ = '$version'" > trakt/__version__.py
cat trakt/__version__.py
python -c "from trakt import __version__; print(__version__)"
# Install deps and build docs
pip install -r requirements.txt
sudo apt install sphinx
make docs
- name: Setup Pages
uses: actions/configure-pages@v2
- name: Upload artifact
uses: actions/upload-pages-artifact@v1
with:
path: docs/_build/html
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v1
# vim:ts=2:sw=2:et