Doc review of PyGranta metapackage

[PipKat]

@MaxJPRey I put the review of the documentation for this smaller package before the review for SCADE API Tools

Here are the issues that I believe need to be addressed:

• [ ] A card for the serverapi-openapi package is missing from the files for each doc section.
• [ ] The doc for this repo, like the doc for many repos, repeats the installation information in two places (the README and the "Getting started" section. Recently, we've put links and a brief descriptions to each section of the doc in the README. (See the README for https://github.com/ansys/pyedb-core.) If we follow this pattern, we'd move/consolidate the user and offline installation instructions to the "Getting started" section (rather than have it in two places). For other repositories, we have put developer installation instructions in the "Contribute" section. (See how we've done that here: https://edb.core.docs.pyansys.com/version/dev/getting_started/index.html.) However, this package doesn't have (or need) such a section because there is no developer install or contribution.
• [ ] We may want the cards on the overall index.rst file to go to the repositories rather than to the documentation for the PyGranta packages. This would make each set of cards unique. (If we make this change, the sentence before the cards on the index.rst file will have to be edited.)

Note that I changed the labeling on the existing cards to match the PyGranta library names. (The don't have "MI" in them), and I also added a descriptor of what content they linked to. I had to reword the "User guide" section because the linked PyGranta documentation does not have "User guide" sections as was implied.

Given that we resolve the two issues I've described, I'm OK with this documentation.

[Andy-Grigg]

Hi @PipKat, thanks for the review! Your changes all look good to me. If I get chance today I'll make the additional changes you requested, but I'll probably defer to @ludovicsteinbach, I think he's working a little bit next week,

[ludovicsteinbach]

@PipKat Thank you for reviewing the documentation.

I'll start by saying that this is heavily inspired (copied) from the pyansys meta-package repository.

• Regarding serverapi-openapi: it does not have documentation, because it is completely auto-generated and we don't recommend users use it directly. If it's adding confusion, perhaps we should remove it from the README?
  • Happy to make the change in the Getting started section to reduce duplication. In other repos, I've used include directives with carefully defined references in the README to only pull relevant sections into the docs. Happy to use the new recommended approach of linking to the docs.
  • No strong opinion on whether we should link to the repo instead of the docs from the overall index. It should be as easy to navigate from the docs to the repo, as from the repo to the docs. Linking to the docs is consistent with the general PyAnsys docs.

[MaxJPRey]

@ludovicsteinbach or @PipKat I will let you merge this PR. Thanks for your work @PipKat .

[PipKat]

@ludovicsteinbach I'll let you merge this PR when you are satisified with it. Thanks!