Edits for doc review before public release (#69)

Co-authored-by: Camille <78221213+clatapie@users.noreply.github.com>
Co-authored-by: Roberto Pastor Muela <37798125+RobPasMue@users.noreply.github.com>

Author: 3 people

.github/workflows/ci_cd.yml

@@ -307,6 +307,7 @@ jobs:
           checkout: false
           skip-install: true
           sphinxopts: -j auto
+          requires-xvfb: true
 
 
   package:

README.rst

@@ -30,8 +30,8 @@ PyAnsys Math
 PyAnsys Math is a Python repository holding Ansys mathematical libraries.
 To use them, you must have a local installation of Ansys Mechanical APDL.
 
-For more information on getting a licensed copy of Ansys Mechanical APDL, visit
-the `Ansys web site <https://www.ansys.com/>`_ .
+For information on getting a licensed copy of Ansys Mechanical APDL, visit
+the `Ansys web site <https://www.ansys.com/>`_.
 
 
 
@@ -43,12 +43,15 @@ For users
 The ``ansys.math.core`` package currently supports Python 3.7 through
 Python 3.10 on Windows, Mac OS, and Linux.
 
+Install the latest package for use with this command:
+
 .. code::
 
    pip install ansys-math-core
 
-Alternatively, install the latest from 
-`PyAnsys Math GitHub <https://github.com/pyansys/pyansys-math.git>`_ via:
+Alternatively, install the latest
+`PyAnsys Math GitHub <https://github.com/pyansys/pyansys-math.git>`_ package
+with this command:
 
 .. code::
 
@@ -58,16 +61,17 @@ Alternatively, install the latest from
 
 For developers
 ~~~~~~~~~~~~~~
-For a local *development* version, install with:
+For a local *development* version, install the latest package with:
 
 .. code::
 
    git clone https://github.com/pyansys/pyansys-math.git
    cd pyansys-math
    pip install -e .
 
-This allows you to install and edit the ``ansys-math-core`` module locally.
-The changes that you make are reflected in your setup
+
+Installing the development version allows you to edit the ``ansys-math-core``
+package locally. The changes that you make are reflected in your setup
 after restarting the Python kernel.
 
 
@@ -85,8 +89,8 @@ Check that you can start PyAnsys Math from Python by running this code:
     print(mm)
 
 
-If you see a response from the server, congratulations. You're ready
-to start using PyAnsys Math as a service.
+If you see a response from the server, you can start using PyAnsys Math
+as a service.
 
 Ansys software requirements
 ---------------------------

doc/source/contributing/index.rst

@@ -1,7 +1,7 @@
 .. _ref_contributing:
 
-Contributing
-============
+Contribute
+==========
 
 Overall guidance on contributing to a PyAnsys library appears in the
 `Contributing <dev_guide_contributing_>`_ topic
@@ -10,8 +10,8 @@ with this guide before attempting to contribute to PyAnsys Math.
 
 The following contribution information is specific to PyAnsys Math.
 
-Cloning the repository
-----------------------
+Clone the repository
+--------------------
 
 Run this code to clone and install the latest version of PyAnsys Math in development mode::
 
@@ -20,8 +20,8 @@ Run this code to clone and install the latest version of PyAnsys Math in develop
     python -m pip install --upgrade pip
     pip install -e .
 
-Posting issues
---------------
+Post issues
+-----------
 
 Use the `PyAnsys Math Issues <pymath_issues_>`_ page to submit questions,
 report bugs, and request new features. When possible, use these issue
@@ -35,8 +35,8 @@ If your issue does not fit into one of these categories, create your own issue.
 To reach the PyAnsys support team, email `pyansys.support@ansys.com <pyansys_support_>`_.
 
 
-Building documentation
-----------------------
+Build documentation
+-------------------
 
 To build the PyAnsys Math documentation locally, in the root directory of the repository, run::
     
@@ -52,8 +52,8 @@ Documentation for the latest development version, which tracks the
 This version is automatically kept up to date via GitHub actions.
 
 
-Code style
-----------
+Adhere to code style
+--------------------
 
 PyAnsys Math follows the PEP8 standard as outlined in the `PyAnsys Development Guide
 <dev_guide_pyansys_>`_ and implements style checking using
@@ -68,7 +68,7 @@ You can also install this as a pre-commit hook by running this code::
 
   pre-commit install
 
-This way, it's not possible for you to push code that fails the style checks. For example::
+This way, it's not possible for you to push code that fails the style checks::
 
   $ pre-commit install
   $ git commit -am "added my cool feature"

doc/source/index.rst

@@ -5,34 +5,33 @@ PyAnsys Math documentation
 Introduction
 ------------
 
-PyAnsys Math aims to gather all the mathematical calculation tools present
-in the Ansys software.
+PyAnsys Math aims to gather all mathematical calculation tools present
+in Ansys software.
 
-This library provides the ability to access and manipulate large
-sparse matrices and solve a variety of eigenproblems. It is presented in a
-similar manner to the popular `NumPy <numpy_docs_>`_ and
-`SciPy <scipy_docs_>`_ libraries.
+This Python library allows you to access and manipulate large sparse matrices
+and solve a variety of eigenproblems. It is presented in a similar manner to
+the popular `NumPy <numpy_docs_>`_ and `SciPy <scipy_docs_>`_ libraries.
 
-The PyAnsys Math command set is based on tools for manipulating large mathematical
+The command set for PyAnsys Math is based on tools for manipulating large mathematical
 matrices and vectors that provide access to standard linear algebra operations and the
-powerful sparse linear solvers of Ansys Mechanical APDL, providing the ability to solve
-eigenproblems.
+powerful sparse linear solvers of Ansys Mechanical APDL (MAPDL), providing the ability
+to solve eigenproblems.
 
 Python and MATLAB eigensolvers are based on the publicly available
-LAPACK libraries and provide reasonable solve time for eigenproblems
+LAPACK libraries and provide reasonable solve times for eigenproblems
 with relatively small degrees of freedom (DOF), perhaps 100,000.
 However, Ansys solvers are designed for the scale of hundreds of
 millions of DOF, providing a variety of situations where you can
 directly leverage Ansys high-performance solvers on a variety of
 eigenproblems. Fortunately, you can leverage this without relearning
 an entirely new language because PyAnsys Math is written in a similar manner
-as the ``NumPy`` and ``SciPy`` libraries. For example, here is a comparison between
+as the NumPy and SciPy libraries. For example, here is a comparison between
 the NumPy and SciPy linear algebra solvers and the PyAnsys Math solver:
 
-.. table:: ``NumPy`` and ``SciPy`` vs ``PyAnsys Math`` implementation
+.. table:: NumPy and SciPy versus PyAnsys Math implementation
 
    +--------------------------------------------+-----------------------------------+
-   | ``NumPy`` and ``SciPy``                    | ``PyAnsys Math``                  |
+   | NumPy and SciPy                            | PyAnsys Math                      |
    +============================================+===================================+
    | .. code:: python                           | .. code:: python                  |
    |                                            |                                   |
@@ -47,20 +46,16 @@ the NumPy and SciPy linear algebra solvers and the PyAnsys Math solver:
 Background
 ----------
 
-PyAnsys Math is a library using the Ansys Mechanical APDL (MAPDL) solver in the
-background.
+PyAnsys Math uses the MAPDL solver in the background. It is based on the
+``launch_mapdl()`` method from PyMAPDL's `ansys-mapdl-core <pymapdl_github_>`_
+package.
 
-It is based on the ``launch_mapdl()`` method from the `ansys-mapdl-core
-<pymapdl_github_>`_ library. The latter uses `gRPC <grpc_>`_, which allows
-the MAPDL solver to function as a server, ready to respond to connecting
-clients.
-
-Google Remote Procedure Calls, or gRPC, are used to establish secure 
-connections so that a client app can directly call methods on 
-a potentially remote MAPDL instance as if it were a local object. The 
-use of HTTP/2 makes it friendly to modern internet infrastructures. 
-This, along with the use of binary transmission formats, favors higher
-performance.
+Because PyMAPDL is `gRPC <grpc_>`_-based, the MAPDL solver can function as
+a server, ready to respond to connecting clients. With gRPC establishing
+secure connections, a client app can directly call methods on a potentially
+remote MAPDL instance as if it were a local object. The use of HTTP/2 makes
+gRPC friendly to modern internet infrastructures. This, along with the use
+of binary transmission formats, favors higher performance.
 
 
 Quick code
@@ -87,7 +82,7 @@ Here is a brief example of how you use PyAnsys Math:
       1.417e+00   1.997e+00   1.720e+00   1.933e+00   1.000e+00      <       5
 
 
-For additional PyAnsys Math examples, see :ref:`ref_pymath_examples`.
+For comprehensive PyAnsys Math examples, see :ref:`ref_pymath_examples`.
 
 
 .. toctree::

examples/README.txt

@@ -2,4 +2,4 @@
 
 Examples
 ========
-These examples demonstrate using the PyAnsys Math library.
+These examples show how you use the PyAnsys Math library.