3adb3d03a0
Bumps [actions/upload-artifact](https://github.com/actions/upload-artifact) from 3 to 4. - [Release notes](https://github.com/actions/upload-artifact/releases) - [Commits](https://github.com/actions/upload-artifact/compare/v3...v4) --- updated-dependencies: - dependency-name: actions/upload-artifact dependency-type: direct:production update-type: version-update:semver-major ... Signed-off-by: dependabot[bot] <support@github.com>
106 lines
3.3 KiB
YAML
106 lines
3.3 KiB
YAML
name: Documentation
|
|
on:
|
|
pull_request:
|
|
|
|
env:
|
|
DOXY_VER: '1.9.6'
|
|
|
|
concurrency:
|
|
group: ${{ github.workflow }}-${{ github.head_ref && github.ref || github.run_id }}
|
|
cancel-in-progress: true
|
|
|
|
jobs:
|
|
Build_Doc:
|
|
runs-on: ubuntu-20.04
|
|
steps:
|
|
- name: Clone OpenVINO
|
|
uses: actions/checkout@v4
|
|
with:
|
|
submodules: 'true'
|
|
lfs: 'true'
|
|
|
|
- name: Install apt-get dependencies
|
|
uses: awalsh128/cache-apt-pkgs-action@v1.3.1
|
|
with:
|
|
packages: graphviz texlive liblua5.2-0 libclang1-9 libclang-cpp9
|
|
version: 3.0
|
|
|
|
- uses: actions/setup-python@v5
|
|
id: cp310
|
|
with:
|
|
python-version: '3.10'
|
|
cache: 'pip'
|
|
cache-dependency-path: |
|
|
docs/requirements.txt
|
|
docs/openvino_sphinx_theme/setup.py
|
|
|
|
- name: Install python dependencies
|
|
run: |
|
|
python3 -m pip install -r docs/requirements.txt
|
|
(cd docs/openvino_sphinx_theme && python3 setup.py install)
|
|
|
|
- name: Download and install doxygen
|
|
run: |
|
|
# install doxygen
|
|
wget https://www.doxygen.nl/files/doxygen-$DOXY_VER.linux.bin.tar.gz
|
|
tar -xzf doxygen-$DOXY_VER.linux.bin.tar.gz
|
|
echo "$(pwd)/doxygen-$DOXY_VER/bin/" >> $GITHUB_PATH
|
|
|
|
- name: Build docs
|
|
run: |
|
|
rm -rf build && mkdir build && cd build
|
|
cmake .. -DCMAKE_BUILD_TYPE=Release -DENABLE_DOCS=ON -DENABLE_CPP_API=ON
|
|
cmake --build . --target sphinx_docs
|
|
|
|
- name: Cache documentation
|
|
id: cache_sphinx_docs
|
|
uses: actions/cache@v3
|
|
with:
|
|
path: build/docs/_build/.doctrees
|
|
key: sphinx-docs-cache
|
|
|
|
- name: Archive docs HTML
|
|
run: (cd build/docs && zip -r openvino_docs_html.zip _build)
|
|
|
|
- name: Set PR number
|
|
run: |
|
|
PR_NUMBER=$(echo $GITHUB_REF | awk 'BEGIN { FS = "/" } ; { print $3 }')
|
|
echo "PR_NUMBER=$PR_NUMBER" >> $GITHUB_ENV
|
|
|
|
- name: 'Upload doxygen.log'
|
|
uses: actions/upload-artifact@v4
|
|
with:
|
|
name: doxygen_build_log_${{ env.PR_NUMBER }}.log
|
|
path: build/docs/doxygen.log
|
|
|
|
- name: 'Upload sphinx.log'
|
|
uses: actions/upload-artifact@v4
|
|
with:
|
|
name: sphinx_build_log_${{ env.PR_NUMBER }}.log
|
|
path: build/docs/sphinx.log
|
|
|
|
- name: 'Upload docs html'
|
|
uses: actions/upload-artifact@v4
|
|
with:
|
|
name: openvino_docs_html_${{ env.PR_NUMBER }}.zip
|
|
path: build/docs/openvino_docs_html.zip
|
|
|
|
- name: Run Pytest
|
|
run: |
|
|
pytest --doxygen="./build/docs/doxygen.log" \
|
|
--sphinx="./build/docs/sphinx.log" \
|
|
--suppress-warnings="./docs/scripts/tests/suppress_warnings.txt" \
|
|
--confcutdir="./docs/scripts/tests/" \
|
|
--html="./build/docs/_artifacts/doc-generation.html" \
|
|
--doxygen-strip="$(pwd)" \
|
|
--sphinx-strip="$(pwd)/build/docs/sphinx_source" \
|
|
--xfail="./docs/scripts/tests/xfail.txt" \
|
|
--self-contained-html ./docs/scripts/tests/test_docs.py
|
|
|
|
- name: 'Upload test results'
|
|
if: failure()
|
|
uses: actions/upload-artifact@v4
|
|
with:
|
|
name: openvino_docs_pytest
|
|
path: build/docs/_artifacts/
|