From 44efc57a3d2fb3e9aedc7dde470807c7477151a2 Mon Sep 17 00:00:00 2001 From: Dominik Gresch Date: Tue, 20 Feb 2024 11:20:55 +0100 Subject: [PATCH] Fix vale warnings (#423) Vale had a breaking change / bug where warnings now cause a non-zero exit code. To get PR (e.g. dependabot) working again, we need to fix the warnings. --- README.rst | 6 +++--- doc/source/intro.rst | 4 ++-- doc/styles/Vocab/ANSYS/accept.txt | 5 ++++- 3 files changed, 9 insertions(+), 6 deletions(-) diff --git a/README.rst b/README.rst index c2c893c2d..bb8c3fe86 100644 --- a/README.rst +++ b/README.rst @@ -103,7 +103,7 @@ server is started. #. Run tests with a Docker container: - Follow the steps in `Getting The DPF Server Docker Image`_ to get + Follow the steps in `Getting the DPF server Docker image`_ to get and run the DPF docker image. Run the tests with the following command .. code:: bash @@ -130,7 +130,7 @@ server is started. Build documentation =================== -Follow the description in `Getting The DPF Server Docker Image`_ image to get +Follow the description in `Getting the DPF server Docker image`_ image to get and run the dpf docker image. On Windows, build the documentation with: @@ -196,5 +196,5 @@ released versions. .. _Sphinx: https://www.sphinx-doc.org/en/master/ .. _tox: https://tox.wiki/ .. _Examples: https://composites.dpf.docs.pyansys.com/version/stable/examples/index.html -.. _Getting The DPF Server Docker Image: https://composites.dpf.docs.pyansys.com/version/stable/intro.html#getting-the-dpf-server-docker-image +.. _Getting the DPF server Docker image: https://composites.dpf.docs.pyansys.com/version/stable/intro.html#getting-the-dpf-server-docker-image .. _Ansys DPF: https://dpf.docs.pyansys.com/version/stable/ diff --git a/doc/source/intro.rst b/doc/source/intro.rst index b99635ffb..6ed4c9562 100644 --- a/doc/source/intro.rst +++ b/doc/source/intro.rst @@ -128,8 +128,8 @@ By default the DPF server is started from the latest Ansys installer. To choose .. _Get DPF Docker image: -Getting the DPF Server Docker Image +Getting the DPF server Docker image """"""""""""""""""""""""""""""""""" Follow the steps described in the DPF documentation in the section `Run DPF Server in A Docker Container `_. Make sure you also download the composites plugin (e.g ``ansys_dpf_composites_lin_v2024.1.pre0.zip``). -After following the steps above, you should have a running DPF docker container that listens to port 50052. +After following the preceding steps, you should have a running DPF Docker container that listens to port 50052. diff --git a/doc/styles/Vocab/ANSYS/accept.txt b/doc/styles/Vocab/ANSYS/accept.txt index 4718da326..f6a316779 100644 --- a/doc/styles/Vocab/ANSYS/accept.txt +++ b/doc/styles/Vocab/ANSYS/accept.txt @@ -8,4 +8,7 @@ postprocess Postprocessing postprocessing ply-wise - +API +Docker +DPF +dpf