From 5ccbb49026ea9200beb3a48fc0732e6c30cf3d4f Mon Sep 17 00:00:00 2001 From: Harshal Pohekar <106588300+hpohekar@users.noreply.github.com> Date: Thu, 17 Oct 2024 12:42:30 +0530 Subject: [PATCH] fix: doc-style fix (#3400) * fix: doc-style fix * fix: doc-style fix 1 * fix: doc-style fix 2 * fix: doc-style fix 3 * fix: doc-style fix 4 * fix: doc-style fix 5 * fix: doc-style fix 6 * fix: doc-style fix 7 * fix: doc-style fix 8 * fix: doc-style fix 9 --- .github/workflows/ci.yml | 10 +-- .vale.ini => doc/.vale.ini | 2 +- doc/styles/.gitignore | 4 + .../config/vocabularies/ANSYS/accept.txt | 80 +++++++++++++++++++ .../config/vocabularies/ANSYS/reject.txt | 0 5 files changed, 88 insertions(+), 8 deletions(-) rename .vale.ini => doc/.vale.ini (96%) create mode 100644 doc/styles/.gitignore create mode 100644 doc/styles/config/vocabularies/ANSYS/accept.txt create mode 100644 doc/styles/config/vocabularies/ANSYS/reject.txt diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index bfcaa3fd87d..c65ac1e0d2a 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -47,15 +47,11 @@ jobs: steps: - uses: actions/checkout@v4 - name: Running Vale - uses: errata-ai/vale-action@reviewdog - env: - GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}} + uses: ansys/actions/doc-style@v8 with: + token: ${{ secrets.GITHUB_TOKEN }} files: doc - reporter: github-pr-check - level: error - filter_mode: nofilter - fail_on_error: true + vale-config: doc/.vale.ini code-style: name: Code style diff --git a/.vale.ini b/doc/.vale.ini similarity index 96% rename from .vale.ini rename to doc/.vale.ini index 0fa4461b4e4..83e9a3df330 100644 --- a/.vale.ini +++ b/doc/.vale.ini @@ -2,7 +2,7 @@ # ============= # Location of our `styles` -StylesPath = .github/styles +StylesPath = "styles" # The options are `suggestion`, `warning`, or `error` (defaults to “warning”). MinAlertLevel = warning diff --git a/doc/styles/.gitignore b/doc/styles/.gitignore new file mode 100644 index 00000000000..62d72f2c268 --- /dev/null +++ b/doc/styles/.gitignore @@ -0,0 +1,4 @@ +* +!config +!config/** +!.gitignore \ No newline at end of file diff --git a/doc/styles/config/vocabularies/ANSYS/accept.txt b/doc/styles/config/vocabularies/ANSYS/accept.txt new file mode 100644 index 00000000000..b0800800333 --- /dev/null +++ b/doc/styles/config/vocabularies/ANSYS/accept.txt @@ -0,0 +1,80 @@ +(?i)Ansys +(?i)gRPC +(?i)PyAnsys +[Ff]luent +[Jj]ournaling +[Mm]atplotlib +[Pp]athlines +[Pp]ostprocessing +[Ss]ession +[Ss]ettings +[Ss]treaming +API +batch_ops +CAD +caf +CaseFile +CommandArguments +DataFile +Dockerfile +endblock +endfor +endif +error_handler +events +EventsManager +falsy +field_data +Fluent's +fluent_connection +fullname +health_check +hexahedral +inout +interceptors +load_machines +machine_list +mass_average +mass_flow +mass_integrated_average +mesher +meshing's +meshing_queries +meshing_workflow +metaclass +metaclasses +monitor +MonitorsManager +numpy +postprocess +PIM +PyFluent +Pythonic +post_helper +post_objects_container +pyvista +rpc +rpvars +sbatch +scheme_eval +session_base_meshing +session_meshing +session_pure_meshing +session_solver +session_solver_icing +session_solver_lite +slurm +Slurm +SVAR +svar_data +svar_info +SVARs +solution_variable_data +solution_variable_info +transcript +TUI +UDFs +Univa +venv +create_workflow +load_workflow \ No newline at end of file diff --git a/doc/styles/config/vocabularies/ANSYS/reject.txt b/doc/styles/config/vocabularies/ANSYS/reject.txt new file mode 100644 index 00000000000..e69de29bb2d