Skip to content

Add explanation comment to the plc #107

Add explanation comment to the plc

Add explanation comment to the plc #107

Workflow file for this run

name: Docs CI
on:
push:
pull_request:
jobs:
build:
name: "Docs CI"
runs-on: ubuntu-latest
steps:
- name: Checkout Source
uses: actions/checkout@v3
with:
# require history to get back to last tag for version number of branches
fetch-depth: 0
- name: Set up Python
uses: actions/setup-python@v4
with:
python-version: "3.7"
- name: Install Packages
# Can delete this if you don't use graphviz in your docs
run: sudo apt-get install graphviz
- name: Install Python Dependencies
run: |
pip install pipenv
pipenv install --dev --deploy --python $(which python) && pipenv graph
- name: Build Docs
run: pipenv run docs
- name: Move to versioned directory
# e.g. master or 0.1.2
run: mv build/html ".github/pages/${GITHUB_REF##*/}"
- name: Publish Docs to gh-pages
# Only master and tags are published
if: "${{ github.repository_owner == 'dls-controls' && (github.ref == 'refs/heads/master' || startsWith(github.ref, 'refs/tags')) }}"
# We pin to the SHA, not the tag, for security reasons.
# https://docs.github.com/en/actions/learn-github-actions/security-hardening-for-github-actions#using-third-party-actions
uses: peaceiris/actions-gh-pages@bbdfb200618d235585ad98e965f4aafc39b4c501 # v3.7.3
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: .github/pages
keep_files: true