Skip to content

Commit

Permalink
Add GHA for doc
Browse files Browse the repository at this point in the history
  • Loading branch information
tfcollins authored Aug 17, 2024
1 parent 326558a commit 94cbb02
Showing 1 changed file with 53 additions and 0 deletions.
53 changes: 53 additions & 0 deletions .github/workflows/doc.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
name: Documentation Tests

on: [push, pull_request]

jobs:
CheckDocs:
runs-on: ubuntu-latest

steps:
- uses: actions/checkout@v2
- name: Set up Python 3.8
uses: actions/setup-python@v2
with:
python-version: 3.8

- name: Install dependencies
run: |
sudo apt-get -qq update
sudo apt-get install -y git cmake graphviz libavahi-common-dev libavahi-client-dev libaio-dev libusb-1.0-0-dev libxml2-dev rpm tar bzip2 gzip flex bison git libzstd-dev doxygen
mkdir build
cd build
cmake .. -DWITH_MAN=ON -DHAVE_DNS_SD=OFF
make
cd ..
cd docs
pip install -r requirements_doc.txt
cd ..
- name: Build man pages
run: |
cd docs
python man_to_rst.py
cd ..
- name: Check doc build
run: |
cd doc
make html SPHINXOPTS="-W"
cd ..
- name: Check doc coverage
run: |
cd doc
make coverage
cat build/coverage/python.txt
cat build/coverage/python.txt | wc -l | xargs -I % test % -eq 2
cd ..
- name: Check doc links
run: |
cd doc
make linkcheck
cd ..

0 comments on commit 94cbb02

Please sign in to comment.