Skip to content

Adds documentation for Utility Functions (#222) #11

Adds documentation for Utility Functions (#222)

Adds documentation for Utility Functions (#222) #11

Workflow file for this run

name: Publish Docs
on:
push:
branches: [ master ]
paths:
- 'docs/**'
release:
types: [published]
workflow_dispatch:
inputs:
git-ref:
description: Git Ref (Optional)
required: false
jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
with:
submodules: recursive
- name: Checkout gh-pages
uses: actions/checkout@v2
with:
ref: gh-pages
path: docs/_web
- name: Set up Python 3.9
uses: actions/setup-python@v2
with:
python-version: 3.9
- name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install -r docs/requirements.txt
sudo apt-get update && sudo apt-get install -y octave liboctave-dev graphviz
- name: Build and Deploy Docs
run: |
cd docs
make html
octave --no-gui --no-window-system buildM2htmlDocs.m
dot -Tpng build/html/api_reference/graph.dot -o build/html/api_reference/graph.png
python deploy.py ${{github.ref}}
cd _web
git config user.name github-actions
git config user.email [email protected]
git add -A
git commit -m "Publish Documentation" || true
git push