Skip to content

Commit

Permalink
CI: remove potential vale warnings (#3806)
Browse files Browse the repository at this point in the history
* CI: use ansys action doc-style

* CI: remove potential vale warnings

At least since version 2.29.3 of vale, titles are also checked by vale.
Thus, multiple warning started appearing due to non deterministic
behavior when using multiple (differently-cased) entries for the same
terme.

The proposed solution consists in reworking the accept.txt file.
  • Loading branch information
SMoraisAnsys authored Oct 27, 2023
1 parent b3dddcc commit d598b7c
Show file tree
Hide file tree
Showing 2 changed files with 35 additions and 60 deletions.
19 changes: 6 additions & 13 deletions .github/workflows/build_documentation.yml
Original file line number Diff line number Diff line change
Expand Up @@ -19,22 +19,15 @@ concurrency:

jobs:
docs-style:
name: Documentation Style Check
name: "Check documentation style"
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4

- name: Running Vale
uses: errata-ai/vale-action@reviewdog
env:
GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}
- name: "Check documentation style"
uses: ansys/actions/doc-style@v4
with:
files: doc
reporter: github-pr-check
level: error
filter_mode: nofilter
fail_on_error: true
vale_flags: "--config=doc/.vale.ini"
token: ${{ secrets.GITHUB_TOKEN }}
vale-config: "doc/.vale.ini"
vale-version: "2.29.6"

docs_build:
runs-on: ubuntu-20.04
Expand Down
76 changes: 29 additions & 47 deletions doc/styles/Vocab/ANSYS/accept.txt
Original file line number Diff line number Diff line change
@@ -1,104 +1,86 @@
ANSYS
Ansys
ansys
2D Extractor
2D modeler
3D modeler
_static
AEDB
API
AEDT
AEDT API
2D Extractor
airbox
airgap
(?i)Ansys
API
autosave
busbar
busbars
Bz
circuit
Circuit
com
COM
[Cc]ircuit
codecov
[Cc]om
COM interface
Components
components
[Cc]omponents
Conda
CPython
DesignXploration
docstring
Docstrings
docstrings
[Dd]ocstrings
doppler
EDB
EDB API
EDT
efields
EMIT
getters
globals
gRPC
GRPC
[Gg]gRPC
HFSS
HFSS 3D Layout
Huray
Icepak
IronPython
[Ll]ayout
limitilines
Layout
layout
matplotlib
Maxwell 2D
Maxwell 3D
Maxwell Circuit
Mechanical
[Mm]echanical
multiphysics
multiplot
namespaces
netlist
Nexxim
numpy
numpydoc
optimetrics
Optimetrics
[Oo]ptimetrics
padstack
padstacks
parametrics
polyline
PMs
[Pp]olyline
polylines
Polyline
Postprocessing
PMs
pwl
pyaedt
PyAEDT
PyAnsys
PyPI
(?i)PyAnsys
[Pp]y[Pp][Ii]
Python
Python.NET
pyvista
Q2D Extractor
Q3D Extractor
Q3D
Q3D Extractor
RC
reusability
RF
RMXprt
scipy
Siwave
setters
Siwave
Slurm
Spyder
Stackup 3D
stackups
stripline
subcircuit
[Tt]oolkits
Twin Builder
Uncomment
vias
_static
pwl
Conda
PyAnsys
codecov
mechanical
reusability
pypi
EDT
pyansys
Slurm
Python.NET
Toolkits
toolkits
3D modeler
2D modeler
Stackup 3D

0 comments on commit d598b7c

Please sign in to comment.