Edits to RST files and only resolve Vale issues in PY files

Author: PipKat

README.rst

@@ -31,8 +31,33 @@ PyHPS
    :alt: Black
 
 
-A Python client library for the Ansys HPC Platform Services.
+PyHPS is a Python client library for Ansys HPC Platform Services (HPS), which is
+a set of technology components designed to help you manage the execution of simulations
+while making use of your full range of computing assets.
 
+PyHPS brings Ansys HPS to your Python app. Wrapping around the HPS REST APIs, PyHPS allows you to:
+
+* Create projects and modify existing ones.
+* Monitor and manage jobs.
+* Run your own design exploration algorithms .
+* Retrieve simulation results.
+
+Documentation
+-------------
+The `PyHPS documentation <https://rep.docs.pyansys.com/>`_ contains these sections:
+
+- `Getting started <https://rep.docs.pyansys.com/dev/getting-started/index.html>`_: Explains
+  how to install PyHPS in user mode.
+- `User guide <https://rep.docs.pyansys.com/dev/user_guide/index.html>`_: Describes how to use
+  PyHPS to interact with Ansys HPS.
+- `Examples <https://rep.docs.pyansys.com/dev/examples/index.html>`: Provides examples of how
+  to interact with a REP server in Python using PyHPS.
+- `API reference <https://rep.docs.pyansys.com/dev/api/index.html>`_: Describes PyHPS functions,
+  classes, methods, and their parameters and return values so that you understand how to interact
+  with them programmatically
+- `Contribute <https://rep.docs.pyansys.com/dev/contribute.html>`: Provides information on
+  how to install PyHPS in developer mode and make contributions to the codebase.
+   
 How to install
 --------------
 

doc/.vale.ini

@@ -26,3 +26,10 @@ Vocab = ANSYS
 
 # Apply the following styles
 BasedOnStyles = Vale, Google
+
+TokenIgnores = (:(func|class|meth|attr|py):`(?:.|\n)*?`)|(<.*>)
+
+# Removing Google-specific rule - Not applicable under some circumstances
+Google.Colons = NO
+Google.Headings = NO
+Google.Spacing = NO

doc/source/_static/README.md

@@ -1 +1 @@
-Static files will be found here (like images and other assets).
+Static files (like images and other assets) are found here.

doc/source/api/exceptions.rst

@@ -1,10 +1,10 @@
 Exceptions
-===========================
+==========
 
-HTTP requests returning an unsuccessful status code will raise:
+HTTP requests returning an unsuccessful status code raise one of these exceptions:
 
-* :exc:`ansys.hps.client.ClientError` for client errors (4xx status code, e.g. bad syntax or not found)
-* :exc:`ansys.hps.client.APIError` for server errors (5xx status code, e.g. internal server error or not implemented)
+* :exc:`ansys.hps.client.ClientError` for client errors (4xx status code), such as include bad syntax or not found.
+* :exc:`ansys.hps.client.APIError` for server errors (5xx status code), such as internal server errors or not implemented.
 
 All exceptions that the Ansys REP clients explicitly raise inherit from :exc:`ansys.hps.client.HPSError`.
 

doc/source/api/index.rst

@@ -1,9 +1,10 @@
 .. _api_reference:
 
-Code Documentation
-===========================
+API reference
+=============
 
-If you are looking for information on a specific function, class, or method, this part of the documentation is for you.
+This section describes PyHPS functions, classes, methods, and their parameters and return values
+so that you understand how to interact with them programmatically.
 
 .. toctree::
   :maxdepth: 3

doc/source/api/jms.rst

@@ -1,45 +1,47 @@
 Job Management Service
-===========================
+======================
 
-Ansys REP includes Job Management Service (JMS), which is the main service for storing and evaluating jobs using multiple heterogeneous compute resources. 
+Ansys REP includes Job Management Service (JMS), which is the main service for storing
+and evaluating jobs using multiple heterogeneous compute resources. 
 
-The Python subpackage ``ansys.hps.client.jms`` wraps around the JMS service REST API available at ``https://hostname:port/rep/jms/api``.
+The ``ansys.hps.client.jms`` Python subpackage  wraps around the JMS service REST API,
+which is available at ``https://hostname:port/rep/jms/api``.
 
 APIs
---------------------------------------
+----
 
-JMS Api
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+JMS API
+^^^^^^^
 .. autoclass:: ansys.hps.client.jms.JmsApi
    :members:
    :undoc-members:
 
-Project Api
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+Project API
+^^^^^^^^^^^
 .. autoclass:: ansys.hps.client.jms.ProjectApi
    :members:
    :undoc-members:
 
 
 Resources
---------------------------------------
+---------
 
 File
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+^^^^
 
 .. autoclass:: ansys.hps.client.jms.File
    :members:
 
 Project
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+^^^^^^^
 
 .. autoclass:: ansys.hps.client.jms.Project
    :members:
    :undoc-members:
    :exclude-members: Meta
 
-Fitness Definition
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+Fitness definition
+^^^^^^^^^^^^^^^^^^
 
 .. autoclass:: ansys.hps.client.jms.FitnessTermDefinition
    :members:
@@ -49,7 +51,7 @@ Fitness Definition
 
 
 Parameters
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+^^^^^^^^^^
 
 .. autoclass:: ansys.hps.client.jms.FloatParameterDefinition
    :members:
@@ -66,8 +68,8 @@ Parameters
 .. autoclass:: ansys.hps.client.jms.ParameterMapping
    :members:
 
-Task Definition
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+Task definition
+^^^^^^^^^^^^^^^
 
 .. autoclass:: ansys.hps.client.jms.Software
    :members:
@@ -85,37 +87,37 @@ Task Definition
    :members:
 
 
-Job Definition
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+Job definition
+^^^^^^^^^^^^^^
 
 .. autoclass:: ansys.hps.client.jms.JobDefinition
    :members:
    :undoc-members:
    :exclude-members: Meta
 
 Task
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+^^^^
 
 .. autoclass:: ansys.hps.client.jms.Task
    :members:
 
 
 Job
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+^^^
 
 .. autoclass:: ansys.hps.client.jms.Job
    :members:
 
 
-Job Selection
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+Job selection
+^^^^^^^^^^^^^
 
 .. autoclass:: ansys.hps.client.jms.JobSelection
    :members:
 
 
-Design Exploration Algorithm
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+Design exploration algorithm
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 .. autoclass:: ansys.hps.client.jms.Algorithm
    :members:
@@ -128,8 +130,8 @@ Evaluator
    :members:
 
 
-Task Definition Template
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+Task definition template
+^^^^^^^^^^^^^^^^^^^^^^^^
 
 .. autoclass:: ansys.hps.client.jms.TemplateProperty
    :members:

doc/source/api/rms.rst

@@ -1,44 +1,46 @@
 Resource Management Service
 ===========================
 
-Ansys REP includes the Resource Management Service (JMS), which is the main service for managing heterogeneous compute resources. 
+Ansys REP includes the Resource Management Service (RMS), which is the main service
+for managing heterogeneous compute resources. 
 
-The Python subpackage ``ansys.hps.client.rms`` wraps around the RMS service REST API available at ``https://hostname:port/rep/rms/api``.
+The ``ansys.hps.client.rms`` Python subpackage wraps around the RMS service REST API, which
+is available at ``https://hostname:port/rep/rms/api``.
 
 APIs
---------------------------------------
+----
 
-RMS Api
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+RMS API
+^^^^^^^
 .. autoclass:: ansys.hps.client.rms.RmsApi
    :members:
    :undoc-members:
 
 
 Resources
---------------------------------------
+---------
 
-Evaluator Registration
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+Evaluator registration
+^^^^^^^^^^^^^^^^^^^^^^
 
 .. autopydantic_model:: ansys.hps.client.rms.EvaluatorRegistration
 
-Evaluator Configuration
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+Evaluator configuration
+^^^^^^^^^^^^^^^^^^^^^^^
 
 .. autopydantic_model:: ansys.hps.client.rms.EvaluatorConfiguration
 
-Evaluator Configuration Update
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+Evaluator configuration update
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 .. autopydantic_model:: ansys.hps.client.rms.EvaluatorConfigurationUpdate
 
-Scaler Configuration
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+Scaler configuration
+^^^^^^^^^^^^^^^^^^^^
 
 .. autopydantic_model:: ansys.hps.client.rms.ScalerRegistration
 
-Compute Resource Set
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+Compute resource set
+^^^^^^^^^^^^^^^^^^^^
 
 .. autopydantic_model:: ansys.hps.client.rms.ComputeResourceSet