-
Notifications
You must be signed in to change notification settings - Fork 320
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
53 additions
and
0 deletions.
There are no files selected for viewing
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
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 .. |