Doc/overall edit dpf post (#144)

* Edits for gettting started and user guide

* Edits to PY files for the API

* More PY file edits

* Edits to examples

* Edit contribute topic

* More edits to examples

* Edits to eliminate Vale errors

* Fix format error in PY file

* Fix more format issues in PY file

* Fix more format issues in PY files

* Fix issues in PY files

* Remove blank space at end of line

* Fix space issues

* Fix yet another doc style issue

* Remove space at end of line

* Fix inconsistent heading level

* Add blank line

* Fix code line (I think it got separated into multiple lines inadvertently.)

* Remove blank spaces after end of lines.

* Remove blank spaces after end of lines.

* Attempt to fix some testing errors

* Fix some more errors

* Keep making changes to try resolving issues

* Add LabelSpaceError and fix coverage

* Fix styling

* Static code quality

* Fix code quality

* Apply suggestions from code review

Co-authored-by: paul.profizi <[email protected]>
Co-authored-by: Roberto Pastor Muela <[email protected]>

Author: 3 people

docs/source/api/index.rst

@@ -1,23 +1,23 @@
-============
-DPF-Post API
-============
-This guide provides an overview of the DPF-Post API.
+=============
+API reference
+=============
 
-DPF-Post leverages three main categories of objects: 
+This section describes the DPF-Post API, which provides
+three main classes:
 
-1. **Solution**: it is the entry point to the results file, its
-   metadata and contents.
+- ``DpfSolution``: Provides the ``Solution`` object, which is the
+  entry point to the result file, its metadata, and contents.
 
-2. **Result**: it provides access to specific result types, in
-   accordance with the type of analysis.
+- ``Result``: Provides access to ``Results`` object, in accordance with
+  the result type and analysis type.
 
-3. **ResultData**: it provides access to the actual data values and
-   closely relates to the DPF-Core "Fields Container" concept.
+- ``ResultData``: Provides access to the actual data values and
+  closely relates to the *fields container* concept in DPF-Core.
 
 
 .. toctree::
+   :hidden:
    :maxdepth: 1
-   :caption: Contents
 
    solution
    result_object

docs/source/api/result_data.rst

@@ -4,10 +4,11 @@
 ``ResultData`` class
 ********************
 
-The :class:`ResultData <ansys.dpf.post.result_data.ResultData>` object is
-obtained from a :class:`Result <ansys.dpf.core.results.Result>` object.  The ``Result``
-class provides access to the result values contained within, as shown in the following
-example:
+The :class:`ResultData <ansys.dpf.post.result_data.ResultData>` class is
+created using the :class:`Result <ansys.dpf.core.results.Result>` class.  The ``Result``
+class provides access to the result values contained in the ``Result`` object.
+
+This example shows how to access ``displacement`` result values:
 
 .. code:: python
 

docs/source/api/result_object.rst

@@ -1,12 +1,14 @@
 .. _ref_api_result_object:
 
-**********
-``Result``
-**********
+****************
+``Result`` class
+****************
 
 The :class:`Result <ansys.dpf.post.result_object.Result>` class provides access
-to different types of result data. This code shows how to access result
-data for displacements, stresses and elastic strains:
+to different types of result data.
+
+This code shows how you can access result data for displacements, stresses, and
+elastic strains:
 
 .. code:: python
 
@@ -26,7 +28,7 @@ data for displacements, stresses and elastic strains:
 
     >>> elastic_strain = solution.elastic_strain()
 
-DPF-Post features separate result classes for each supported result type. For information on
+DPF-Post features separate ``Result`` classes for each supported result type. For information on
 the available types and their interfaces, see :ref:`user_guide_accessing_results`.
 
 .. currentmodule:: ansys.dpf.post

docs/source/api/solution.rst

@@ -1,12 +1,13 @@
 .. _ref_api_solution:
 
-***************
-``DpfSolution``
-***************
+*********************
+``DpfSolution`` class
+*********************
 
 The :class:`DpfSolution <ansys.dpf.post.dpf_solution.DpfSolution>` class is
-the entry point for browsing the contents of the results file. This code shows how
-to load the file and obtain the instance.
+the entry point for browsing the contents of the result file.
+
+This code shows how to load a result file:
 
 .. code:: python