Skip to content

Update README.rst

Update README.rst #314

Workflow file for this run

# Build Sphinx
name: sphinx build html
on:
push:
branches: [ main ]
pull_request:
branches: [ main ]
# Allows you to run this workflow manually from the Actions tab
workflow_dispatch:
jobs:
docs:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v1
- name: Clone MSGPI
run: |
git clone https://github.itap.purdue.edu/wenbinyugroup/msgpi.git
cp -R msgpi/docs/source docs/source/msgpi
rm docs/source/msgpi/conf.py
- uses: actions/setup-python@v2
with:
python-version: '3.8'
- name: Install dependencies
run: |
python3 -m pip install --upgrade pip
pip install -r docs/requirements.txt
sudo apt-get update -y
sudo apt-get install -y latexmk texlive-latex-recommended texlive-latex-extra texlive-fonts-recommended
- name: Build with sphinx
run: |
python -msphinx -M html docs/source docs/build
- name: Commit documentation changes
run: |
git clone https://github.com/wenbinyugroup/ivabs.git --branch gh-pages --single-branch gh-pages
cp -r docs/build/html/* 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
# that.
- name: Push changes
uses: ad-m/github-push-action@master
with:
branch: gh-pages
directory: gh-pages
github_token: ${{ secrets.GITHUB_TOKEN }}