Skip to content

Update README.md

Update README.md #2

Workflow file for this run

name: doc
on: [push]
jobs:
Build:
runs-on: ${{ matrix.os }}
permissions:
contents: write
strategy:
fail-fast: false
matrix:
os: [ubuntu-latest]
python-version: [3.12]
steps:
- name: Checkout Code
uses: actions/checkout@v3
with:
submodules: recursive
- name: Install Python
uses: actions/setup-python@v4
with:
python-version: ${{ matrix.python-version }}
- name: Setup Graphviz
uses: ts-graphviz/setup-graphviz@v1
- name: Install FORD
if: contains( matrix.os, 'ubuntu')
run: |
python -m pip install --upgrade pip
pip install ford
if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
- name: Build FORD Documentation
run: ford ./ford.yml
- name: Deploy Documentation
uses: JamesIves/[email protected]
with:
branch: gh-pages
folder: doc