Skip to content
This repository has been archived by the owner on Nov 17, 2023. It is now read-only.

Commit

Permalink
[CI] Move link check from jenkins to github action (#20526)
Browse files Browse the repository at this point in the history
  • Loading branch information
barry-jin authored Aug 14, 2021
1 parent 18ceff5 commit c6a97e2
Show file tree
Hide file tree
Showing 2 changed files with 77 additions and 1 deletion.
70 changes: 70 additions & 0 deletions .github/workflows/link_check.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,70 @@
name: link check

on: [push, pull_request]

defaults:
run:
shell: bash

jobs:
linkcheck:
runs-on: ubuntu-latest
strategy:
fail-fast: false
steps:
- name: Checkout repository
uses: actions/checkout@v2

- name: Compilation cache
uses: actions/cache@v2
with:
path: ~/.ccache
# We include the commit sha in the cache key, as new cache entries are
# only created if there is no existing entry for the key yet.
key: ${{ runner.os }}-ccache-${{ github.sha }}
# Restore any ccache cache entry, if none for
# ${{ runner.os }}-ccache-${{ github.sha }} exists
restore-keys: |
${{ runner.os }}-ccache
- name: Setup python
uses: actions/setup-python@v2
with:
python-version: '3.6'
architecture: x64

- name: Install Dependencies
run: |
sudo apt-get install -y libopenblas-dev ninja-build ccache python3-sphinx \
pandoc gcc-7 g++-7 libopencv-dev protobuf-compiler libprotobuf-dev
ccache -M 500M # Limit the ccache size; Github's overall cache limit is 5GB
python -m pip install -r docs/python_docs/requirements
python -m pip install docs/python_docs/themes/mx-theme
shell: bash

- name: Build project
env:
CC: gcc-7
CXX: g++-7
run: |
git submodule update --init --recursive
mkdir build; cd build
CXXFLAGS="-Wno-error=strict-overflow" cmake \
-DCMAKE_BUILD_TYPE="RelWithDebInfo" \
-DUSE_ONEDNN=OFF \
-DUSE_CUDA=OFF \
-G Ninja ..
ninja
cd ..
shell: bash

- name: Setup Python
run: |
python -m pip install --user -e python
- name: Link Check
run: |
cd docs/python_docs/python
make clean
make linkcheck EVAL=0
shell: bash
8 changes: 7 additions & 1 deletion docs/python_docs/python/Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -42,14 +42,20 @@ build/%: %
@mkdir -p $(@D)
@cp -r $< $@

linkcheck: $(OBJ)
mkdir -p build;
cp Makefile_sphinx build/Makefile;
cp -n -r ../_static build/ || true;
sphinx-autogen build/api/*.rst build/api/**/*.rst -t build/_templates/;
make -C build linkcheck;

html: $(OBJ)
mkdir -p build;
cp Makefile_sphinx build/Makefile;
cp -n -r ../_static build/ || true;
sphinx-autogen build/api/*.rst build/api/**/*.rst -t build/_templates/;
# make -C build linkcheck doctest html
make -C build linkcheck html;
make -C build html;
sed -i.bak 's/33\,150\,243/23\,141\,201/g' build/_build/html/_static/material-design-lite-1.3.0/material.blue-deep_orange.min.css;
make update_github_link

Expand Down

0 comments on commit c6a97e2

Please sign in to comment.