Add Protocol_Guide for Open/R under CFM rule #143
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
name: Documentation Autoformat check + Build | |
on: | |
push: | |
paths: | |
- ".github/workflows/doc.yml" | |
- ".prettierrc.json" | |
- "openr/docs/**" | |
- "README.md" | |
- "CONTRIBUTING.md" | |
pull_request: | |
paths: | |
- ".github/workflows/doc.yml" | |
- ".prettierrc.json" | |
- "openr/docs/**" | |
- "README.md" | |
- "CONTRIBUTING.md" | |
jobs: | |
build: | |
runs-on: ubuntu-latest | |
steps: | |
- uses: actions/checkout@v3 | |
- uses: actions/setup-node@v3 | |
- name: Set up Python | |
uses: actions/setup-python@v3 | |
- name: Link check markdown + yaml with prettier | |
run: | | |
npm install prettier | |
npx prettier --check *.md openr/docs | |
- name: Install docs dependencies | |
run: | | |
python -m pip install --upgrade pip setuptools wheel | |
python -m pip install -r "openr/docs/requirements.txt" | |
- name: Check all links resolve | |
run: make -C openr/docs linkcheck | |
- name: Build documentation | |
run: make -C openr/docs html |