Skip to content

Commit

Permalink
update poetry check in ci
Browse files Browse the repository at this point in the history
  • Loading branch information
skim0119 committed Jul 5, 2022
1 parent e84b6ed commit 0e4bbac
Showing 1 changed file with 26 additions and 20 deletions.
46 changes: 26 additions & 20 deletions .github/workflows/ci-sphinx.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
name: CI-sphinx
name: CI-sphinx # Build test for static documentation page

# Controls when the workflow will run
on:
Expand All @@ -23,23 +23,29 @@ jobs:
# Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it
- uses: actions/checkout@v3

- name: Setup Poetry
# You may pin to the exact commit or the version.
# uses: Gr1N/setup-poetry@09236184f6c1ab47c0dc9c1001c7fe200cf2afb0
uses: Gr1N/setup-poetry@v7
with:
poetry-preview: false

- name: Sphinx Build
# You may pin to the exact commit or the version.
# uses: ammaraskar/sphinx-action@8b4f60114d7fd1faeba1a712269168508d4750d2
uses: ammaraskar/[email protected]
with:
# The folder containing your sphinx docs.
docs-folder: docs/
# The command used to build your documentation.
build-command: make html # SPHINXOPTS="-W --keep-going" # -n"
# Run before the build command, you can use this to install system level dependencies, for example with "apt-get update -y && apt-get install -y perl"
pre-build-command: |
poetry config virtualenvs.in-project true
- name: Poetry Setup
run: |
apt-get update -y && apt-get install curl
make poetry-download
poetry --version
poetry config virtualenvs.in-project false
poetry config virtualenvs.create false
poetry install -E docs
- name: Sphinx Build Check
run: |
cd docs
make clean
if ! (make html SPHINXOPTS="-W --keep-going") ; then
echo Please resolve the warnings/errors
exit 1
else
echo Doc build success
exit 0
fi
- name: Sphinx Link Check
run: |
cd docs
make clean
make linkcheck

0 comments on commit 0e4bbac

Please sign in to comment.