ansys · clatapie · Oct 17, 2023 · Oct 6, 2023 · Oct 6, 2023 · Oct 6, 2023
@@ -57,13 +57,12 @@ jobs:
   doc-style:
     name: "Documentation style check"
     runs-on: ubuntu-latest
-    #Skipping until 2394 is fixed
-    if:  github.ref == 'Skip for now'
     steps:
       - name: "Ansys documentation style checks"
         uses: ansys/actions/doc-style@v4
         with:
           token: ${{ secrets.GITHUB_TOKEN }}
+          vale-config: .vale.ini
 
   smoke-tests:
     name: "Build and smoke tests"

diff --git a/doc/.vale.ini → .vale.ini b/doc/.vale.ini → .vale.ini
@@ -1,31 +1,31 @@
-# Core settings
-# =============
-
-# Location of our `styles`
-StylesPath = "styles"
-
-# The options are `suggestion`, `warning`, or `error` (defaults to “warning”).
-MinAlertLevel = warning
-
-# By default, `code` and `tt` are ignored.
-IgnoredScopes = code, tt
-
-# By default, `script`, `style`, `pre`, and `figure` are ignored.
-SkippedScopes = script, style, pre, figure
-
-# WordTemplate specifies what Vale will consider to be an individual word.
-WordTemplate = \b(?:%s)\b
-
-# List of Packages to be used for our guidelines
-Packages = Google
-
-# Define the Ansys vocabulary
-Vocab = ANSYS
-
-[*.{md,rst}]
-
-# Apply the following styles
-BasedOnStyles = Vale, Google
-
-# Removing Google-specific rule - Not applicable under some circumstances
-Google.Colons = NO
+# Core settings
+# =============
+
+# Location of our `styles`
+StylesPath = "./doc/styles"
+
+# The options are `suggestion`, `warning`, or `error` (defaults to “warning”).
+MinAlertLevel = warning
+
+# By default, `code` and `tt` are ignored.
+IgnoredScopes = code, tt
+
+# By default, `script`, `style`, `pre`, and `figure` are ignored.
+SkippedScopes = script, style, pre, figure
+
+# WordTemplate specifies what Vale will consider to be an individual word.
+WordTemplate = \b(?:%s)\b
+
+# List of Packages to be used for our guidelines
+Packages = Google
+
+# Define the Ansys vocabulary
+Vocab = ANSYS
+
+[*.{md,rst}]
+
+# Apply the following styles
+BasedOnStyles = Vale, Google
+
+# Removing Google-specific rule - Not applicable under some circumstances
+Google.Colons = NO
@@ -1,5 +1,6 @@
 Translate scripts
 ===================
+
 The `ansys-mapdl-core <pymapdl_docs_>`_
 library contains a few basic functions to translate existing MAPDL
 scripts into PyMAPDL scripts. Ideally, all math and variable setting
@@ -8,7 +9,7 @@
 
 
 Command-line interface
-~~~~~~~~~~~~~~~~~~~~~~
+----------------------
 
 In PyMAPDL v0.64.0 and later, you use the converter from the command line.
 After you have activated and installed the package as described
@@ -40,7 +41,7 @@
 Hence, this command accepts most of this function's arguments.
 
 Usage
------
+~~~~~
 
 You can call this command from the terminal with different
 arguments. Here is an example that converts the ``mapdl.dat``
@@ -90,11 +91,12 @@
 
 Caveats
 ~~~~~~~
+
 These examples only show an automatic translation of a verification:
 file and not optimized code. Should it be necessary to pull
 parameters or arrays from ansys, use the :func:`Mapdl.get_value()
 <ansys.mapdl.core.Mapdl.get_value>` function, which is quite similar to the
 MAPDL :func:`Mapdl.get() <ansys.mapdl.core.Mapdl.get>` 
 command shown here:

 .. code:: pycon
@@ -103,7 +105,7 @@
   4.532094298033

 Alternatively, if a parameter is already defined, you can access it
 using the :attr:`Mapdl.parameters <ansys.mapdl.core.Mapdl.parameters>` attribute
 with:

 .. code:: pycon
@@ -122,6 +124,7 @@
 
 Script translation
 ~~~~~~~~~~~~~~~~~~
+
 Existing Ansys scripts can be translated using the :func:`convert_script() <ansys.mapdl.core.convert_script>`
 function:
 
@@ -158,7 +161,7 @@
 commands can be called as a method to the Ansys object rather than
 sending a string as a command. Additionally, take note that some
 commands require the :attr:`Mapdl.non_interactive
 <ansys.mapdl.core.Mapdl.non_interactive>` context manager since some
 commands require and may break the server connection for some
 interfaces (such as CORBA) or are invalid (as in gRPC).

@@ -169,6 +172,7 @@
 
 Example: VM1 - statically indeterminate reaction force analysis
 ---------------------------------------------------------------
+
 Ansys MAPDL contains over 200 verification files used for Ansys
 validation and demonstration. These validation files are used here to
 demo the use of the PyMAPDL file translator :func:`convert_script()
@@ -336,7 +340,7 @@
 ``mapdl.run('/COM')``. Also, note that the ``*VWRITE`` command
 requires a command immediately following it. This normally locks the
 interface, so it's implemented in the background as an input file
 using the :attr:`Mapdl.non_interactive <ansys.mapdl.core.Mapdl.non_interactive>`
 attribute.



@@ -1,10 +1,6 @@
-
-
-
 .. _ref_troubleshooting:
 
 
-=======================
 Troubleshooting PyMAPDL
 =======================
 
@@ -13,9 +9,8 @@
 some of the most common problems and frequently asked questions are posted here.
 
 
-*****************
 Debug in PyMAPDL
-*****************
+----------------
 
 If you are having trouble with PyMAPDL, you can record some internal
 logs into a file using a logger. 
@@ -43,11 +38,9 @@
 `PyMAPDL Issues page <pymapdl_issues_>`_.
 
 
-.. _debugging_launch_mapdl:
 
-****************
 Launching issues
-****************
+----------------
 
 There are several issues that can cause MAPDL not to launch, including:
 
@@ -255,9 +248,6 @@
 such file or directory``, you are likely missing some necessary
 dependencies.
 
-
-.. _installing_mapdl_on_centos7:
-
 CentOS 7
 --------
 
@@ -268,8 +258,6 @@
     yum install openssl openssh-clients mesa-libGL mesa-libGLU motif libgfortran
 
 
-.. _installing_mapdl_on_ubuntu:
-
 Ubuntu
 ------
 
@@ -520,14 +508,10 @@
     information, see :ref:`conflicts_student_version`.
 
 
-.. _ref_pymapdl_limitations:
-
 *********************
 PyMAPDL usage issues
 *********************
 
-.. _ref_numpy_arrays_in_mapdl:
-
 Issues when importing and exporting numpy arrays in MAPDL
 =========================================================
 
@@ -584,7 +568,6 @@
 
 
 
-.. _ref_pymapdl_stability:
 
 *****************
 PyMAPDL stability
@@ -602,7 +585,7 @@

 When possible, pass ``mute=True`` to individual MAPDL commands or
 set it globally with the :func:`Mapdl.mute
 <ansys.mapdl.core.mapdl_grpc.MapdlGrpc>` method. This disables streaming
 back the response from MAPDL for each command and marginally
 improves performance and stability. Consider having a debug flag in
 your program or script so that you can turn on and off logging and
@@ -613,12 +596,14 @@
 ======
 
 .. note::
+
    MAPDL 2021 R1 has a stability issue with the :func:`Mapdl.input()
    <ansys.mapdl.core.Mapdl.input>` method. Avoid using input files if
-   possible. Attempt to use the :func:`Mapdl.upload()
-   <ansys.mapdl.core.Mapdl.upload>` method to upload nodes and elements and read them
-   in via the :func:`Mapdl.nread() <ansys.mapdl.core.Mapdl.nread>` and
+   possible. Attempt to use the
+   :func:`Mapdl.upload() <ansys.mapdl.core.Mapdl.upload>` method to upload
+   nodes and elements and read them in via the
+   :func:`Mapdl.nread() <ansys.mapdl.core.Mapdl.nread>` and
    :func:`Mapdl.eread() <ansys.mapdl.core.Mapdl.eread>` methods.
 
 


@@ -4,6 +4,7 @@
 [Ee]igensolver
 [Hh]yperelasticity
 [Kk]eypoints
+[Mm]apdl
 [Mm]atplotlib
 [Nn]umpy
 [Pp]ostprocess
@@ -146,6 +147,7 @@ UPF
 UPFs
 viscoplastic
 vise
+von
 VTK
 wan
 WAN