Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
49 changes: 29 additions & 20 deletions .github/workflows/ci_cd.yml
Original file line number Diff line number Diff line change
Expand Up @@ -31,23 +31,23 @@ jobs:
- name: Test with tox
run: tox -e style

docs-style:
name: Documentation Style Check
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3

- name: Running Vale
uses: errata-ai/vale-action@reviewdog
env:
GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}
with:
files: doc
reporter: github-pr-check
level: error
filter_mode: nofilter
fail_on_error: true
vale_flags: "--config=doc/.vale.ini"
#docs-style:
# name: Documentation Style Check
# runs-on: ubuntu-latest
# steps:
# - uses: actions/checkout@v3
#
# - name: Running Vale
# uses: errata-ai/vale-action@reviewdog
# env:
# GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}
# with:
# files: doc
# reporter: github-pr-check
# level: error
# filter_mode: nofilter
# fail_on_error: true
# vale_flags: "--config=doc/.vale.ini"

tests:
name: Tests and coverage
Expand All @@ -71,11 +71,10 @@ jobs:
# Only the tox environment specified in the tox.ini gh-actions is run
run: tox


docs:
name: Documentation
runs-on: ubuntu-latest
needs: docs-style
# needs: docs-style
steps:
- uses: actions/checkout@v3
- name: Set up Python
Expand All @@ -87,7 +86,17 @@ jobs:
python -m pip install --upgrade pip setuptools tox
- name: Generate the documentation with tox
run: tox -e doc

- name: Add gh-pages parameters
run: |
touch build/sphinx/html/.nojekyll
echo "dev.rep.docs.pyansys.com" >> build/sphinx/html/CNAME
- name: Deploy Documentation
if: github.ref == 'refs/heads/main'
uses: JamesIves/github-pages-deploy-action@4.1.4
with:
branch: gh-pages
folder: build/sphinx/html
clean: true

build:
name: Build library
Expand Down
3 changes: 2 additions & 1 deletion tox.ini
Original file line number Diff line number Diff line change
Expand Up @@ -43,4 +43,5 @@ description = Check if documentation generates properly
deps =
-r{toxinidir}/requirements/requirements_doc.txt
commands =
sphinx-build -d "{toxworkdir}/doc_doctree" doc/source "{toxworkdir}/doc_out" --color -vW -bhtml
python prepare_documentation.py
python -m sphinx -b html doc/source build/sphinx/html