Overall doc edit for public release

[PipKat]

Documentation edits are to prepare for public release of the library. I deleted subsequent sections of the PR template because they did't apply. I've reorganized content so that it resides in the five standard sections for PyAnsys library documentation: Getting started, User guide, Examples, API reference, and Contribute.

General observations

• The README file for a PyAnsys library usually has a "License" section. See the PyAEDT README file. Does such a section need to be added to the PyHPS README file? Note that the links in the README file for the documentation and its sections will have to be updated with the URLs for the stable documentation once the library is released. The current links are to the documentation for the dev version because it is currently the only version that exists.
• The installation information in the "Getting started" and "Contribute" sections will have to be updated to convey the steps appropriate for the library once it is made public.
• In the "User guide" section, I'd recommend breaking out the content currently on the landing page into these additional pages: Query parameters, Objects versus dictionaries, Common tasks, and Exception handling. (There is likely a better name than "Common tasks" for this how-to usage content. However, I couldn't easily come up with one!) I didn't want to make such changes in this PR because it will already have conflicts with changes Kerry has made in the PR for her technical review. If you want me to do a reorganization of this section in another PR after both this and Kerry's PRs are merged, let me know.
• The "Examples" section is now showing links in the left navigation pane, although in the previous doc build it wasn't!? Also, should the landing page for this section (and examples) show the default username and password--and what format is the version provided in? (Usually it's in three digits [such as 241] rather than written as "2024 R1"). Lastly, I fixed minor grammar errors in the files shown via includes. For example, I changed "setup" to "set up" when it was used as a verb. However, I hope it was OK to edit the files that appear via includes because they are also included in the ZIP file for the example (and I don't know how/when this ZIP file is generated).
• In the "API reference" section, the right navigation pane only shows links to the top-level sections. It is really hard to find information within these sections. In the auth.rst file, there is a TODO REVIEW paragraph that must definitely be removed! Also, lots of objects are missing descriptions. Would we be able to improve this section before releasing publicly?

[klmcadams]

@PipKat Overall, this looks great! Thank you for all of your edits! To answer some of your observations in the PR description:

• I don't think there would be any harm in adding a "License" section like the one PyAEDT has. I can make note to update the URLs once it's moved to the ansys org and is becoming public
• I can look into the "Examples" and "API reference" navigation panes and see if I can remove the links and expand the sections that are being shown respectively

Federico and Oliver will be able to answer the more specific questions about the PyHPS content itself

[PipKat]

• I don't think there would be any harm in adding a "License" section like the one PyAEDT has.
  @klmcadams @FedericoNegri The problem I see is that it doesn't have a product to link to on the Ansys website. I guess it can be an abbreviated License section.

[FedericoNegri]

• I don't think there would be any harm in adding a "License" section like the one PyAEDT has.
  @klmcadams @FedericoNegri The problem I see is that it doesn't have a product to link to on the Ansys website. I guess it can be an abbreviated License section.

@PipKat https://ansysproducthelpqa.win.ansys.com/account/secured?returnurl=/Views/Secured/prod_page.html?pn=Ansys%20HPC%20Platform%20Services&lang=en

[FedericoNegri]

@PipKat many thanks for the great work! I've tried to address your questions, let me know if you need more clarifications.

Regarding the items you raised in the PR description, I've created this issue to track it. I think would be best to address them in separate PRs - I'm a little worried of the merge conflicts between this and Kerry's branch.

[PipKat]

• I don't think there would be any harm in adding a "License" section like the one PyAEDT has.
  @klmcadams @FedericoNegri The problem I see is that it doesn't have a product to link to on the Ansys website. I guess it can be an abbreviated License section.

@PipKat https://ansysproducthelpqa.win.ansys.com/account/secured?returnurl=/Views/Secured/prod_page.html?pn=Ansys%20HPC%20Platform%20Services&lang=en

@FedericoNegri This link is to the doc QA site. I can only link to the beta guide on the doc production site, which I've done.