Skip to content

Docs: tweak features.md #158

Docs: tweak features.md

Docs: tweak features.md #158

Workflow file for this run

# Simple workflow for deploying static content to GitHub Pages
name: Docs
on:
# Runs on pushes targeting the default branch
push:
branches: [master]
# Allows you to run this workflow manually from the Actions tab
workflow_dispatch:
# Allow one concurrent deployment
concurrency:
group: "pages"
cancel-in-progress: true
jobs:
# Single deploy job since we're just deploying
deploy:
strategy:
matrix:
python-version: ["3.10.8"]
env:
DOCS_DIR: docs
DOCS_BUILD_DIR: docs/build
DOCS_BUILD_HTML_DIR: docs/build/html
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v3
- name: Set up Python ${{ matrix.python-version }}
uses: actions/setup-python@v4
with:
python-version: ${{ matrix.python-version }}
- name: Install dependencies
run: |
pip install -r ${{ env.DOCS_DIR }}/requirements.txt
- name: Build User Manual in HTML
run: |
cd ${{ env.DOCS_DIR }}
make html
- name: Deploy to GitHub Pages
uses: peaceiris/actions-gh-pages@v3
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: ${{ env.DOCS_BUILD_HTML_DIR }}