Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 28 additions & 0 deletions .github/workflows/docs-check.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
name: Documentation Check Before Merge

on:
pull_request:
branches:
- main

jobs:
check-docstrings:
runs-on: ubuntu-latest

steps:
- name: Checkout Repository
uses: actions/checkout@v3

- name: Set up Python
uses: actions/setup-python@v3
with:
python-version: "3.9"

- name: Install Dependencies
run: |
pip install flake8 flake8-docstrings

- name: Run Documentation Checks
run: |
flake8 --select=D sample.py

2 changes: 2 additions & 0 deletions connect_routers.py
Original file line number Diff line number Diff line change
Expand Up @@ -16,3 +16,5 @@ def connect_to_router(router):
routers = load_router_details('routers.yaml')['routers']
for router in routers:
connect_to_router(router)