-
Notifications
You must be signed in to change notification settings - Fork 0
Improve backwards compatibility documentation #175
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Conversation
Most packages require access to an installation of Ansys Granta MI. For more | ||
information on getting a licensed copy of Ansys products, visit the `Ansys website <https://www.ansys.com/>`_. | ||
.. note:: | ||
The ``ansys-grantami-bomanalytics`` and ``ansys-grantami-bomanalytics-openapi`` versions included in the metapackage |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Not sure exactly how I would phrase this, it's a tricky one, but perhaps something like "The ansys-grantami-bomanalytics
and ansys-grantami-bomanalytics-openapi
versions included in the metapackage are compatible with the corresponding version of BoM Analytics Services, included with Granta MI Restricted Substances and Sustainability Reports.
This is normally the latest version available at the time of the metapackage release, however multiple versions of BoM Analytics Services are compatible with a single version of Granta MI."
This is probably the fiddliest section
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I've re-worked this section slightly.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
And I have added a link to the corresponding part of the RS installation guide
1d54d2d
to
fb6952f
Compare
Closes #174
Improve the documentation to describe the backwards compatibility of PyGranta packages.
Also includes a refresh of the Getting Started guide