Overall doc review

[PipKat]

General edits to RST files include using first person, active voice, and present tense when possible.

@tmpbeing, @Revathyvenugopal162, @jorgepiloto The acceptance and merging of this PR completes my overall doc review.
However, some observations follow. These can be moved into one or more issues and addressed in later PRs.

• The doc does not contain the recommended five sections (Getting started, User guide, Examples, API reference, and Contribute. It has only two sections: User guide and API reference. Consider using the five recommended sections as you grow this project.
• The landing pages for both the existing "User guide" and "API reference" sections are simply the toctree structures. Generally, landing pages provide introductory text and allow the left navigation pane provide for accessing the content of interest.
• The "API reference" section uses Google style docstrings. All other (or at least the vast majority) of PyAnsys libraries use NumPy docstrings. This makes it different than other libraries and may make it harder for users to find what they need.
• In the "User guide" section:
  • On the "Client configuration" page (generated from configuration.rst), there are descriptions for configuration and credential options. In some cases, there are two descriptions for an option. I've edited description in the PY files, but I don't know where the unedited descriptions are coming from. I searched the repository for these descriptions and found no matches. Is there a way to eliminate the duplicate descriptions? Also, there are no descriptions for the classmethod clean_url(url) configuration option or the classmethod prompt(values) credential option.
  • On the "Training" page (generated from training.rst), this is the sentence following the steps for training on prediction data: "Once you have training data in your project, you can use the web app to train a model." There should be a "For more information, see X." added here, with X being a link to information on the web app.
  • On the "Best practices" page (generated from best_practices.rst), there is only one topic. I assume you intend to add other topics over time. If not, perhaps change the name to "Asynchronicity" so that the title is more meaningful? Or, consider changing the title to this until more topics are available?
• In the "API reference" section, the Postprocessings page has occurrences of SurfaceEvol. There is no English explanation of what this code entity is. For example, the description for the surface_eval method says: "Compute or get the SurfaceEvol for specific parameters." I didn't want to guess what "SurfaceEvol" was (although it is likely surface evolution). However, you should use plain English here in this docstring and in some others.

[tmpbeing]

Thanks !

[tmpbeing]

Awesome work, thanks ! Just some very minor comments.

As for your suggestion. Some of them are already in our backlog, the others I'll bring to our product team.

[Revathyvenugopal162]

Looks fantastic as always!

[tmpbeing]

🎉