Skip to content
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

Maintenance: Update to PyGranta #309

Merged
merged 2 commits into from
May 12, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ ansys-grantami-bomanalytics

Project Overview
----------------
Granta MI BoM Analytics is part of the larger `PyAnsys <https://github.com/pyansys>`_
PyGranta BoM Analytics is part of the larger `PyAnsys <https://github.com/pyansys>`_
effort to facilitate the use of Ansys technologies directly from Python.

The Granta MI Restricted Substances solution includes a REST API for
Expand Down Expand Up @@ -31,13 +31,13 @@ Alternatively, clone and install this package with this code:

Documentation
-------------
The `Granta MI BoM Analytics Documentation <https://bomanalytics.grantami.docs.pyansys.com>`_
The `PyGranta BoM Analytics Documentation <https://bomanalytics.grantami.docs.pyansys.com>`_
provides comprehensive installation and usage information.


Usage
-----
Here's a brief example of how to use Granta MI BoM Analytics:
Here's a brief example of how to use PyGranta BoM Analytics:

.. code:: python

Expand Down Expand Up @@ -69,5 +69,5 @@ For information on testing, see the ``Contributing`` section of the documentatio

License
-------
Granta MI BoM Analytics is provided under the terms of the MIT license. You can find
PyGranta BoM Analytics is provided under the terms of the MIT license. You can find
this license in the LICENSE file at the root of the repository.
2 changes: 1 addition & 1 deletion doc/source/api/compliance/indicators.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

Indicators
==========
The Granta MI BoM Analytics API determines compliance against an indicator, which essentially represents a legislation
The PyGranta BoM Analytics API determines compliance against an indicator, which essentially represents a legislation
with a threshold. If a substance appears in a certain item, either directly or indirectly, in a quantity that exceeds that
threshold, the item is non-compliant with that indicator. In cases where the
legislation defines a per-substance threshold (for example, RoHS), then this per-substance threshold is used instead.
Expand Down
2 changes: 1 addition & 1 deletion doc/source/api/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
API reference
=============

The API for Granta MI BoM Analytics is split into these key sections:
The API for PyGranta BoM Analytics is split into these key sections:

- :ref:`ref_grantami_bomanalytics_common_connection` describes how to connect to Granta MI and, if required,
configure any schema customizations in the API client. It also explains how to run queries.
Expand Down
6 changes: 3 additions & 3 deletions doc/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
project = "ansys.grantami.bomanalytics"
copyright = f"(c) {datetime.now().year} ANSYS, Inc. All rights reserved"
author = "ANSYS Inc."
html_title = f"Granta MI BoM Analytics {__version__}"
html_title = f"PyGranta BoM Analytics {__version__}"

# The short X.Y version
release = version = __version__
Expand Down Expand Up @@ -45,7 +45,7 @@

# Intersphinx mapping
intersphinx_mapping = {
"python": ("https://docs.python.org/dev", None),
"python": ("https://docs.python.org/3", None),
"openapi-common": ("https://openapi.docs.pyansys.com", None),
# kept here as an example
# "scipy": ("https://docs.scipy.org/doc/scipy/reference", None),
Expand Down Expand Up @@ -137,7 +137,7 @@
"github_url": "https://github.com/pyansys/grantami-bomanalytics",
"additional_breadcrumbs": [
("PyAnsys Documentation", "https://docs.pyansys.com/"),
("Granta MI", "https://grantami.docs.pyansys.com/"),
("PyGranta", "https://grantami.docs.pyansys.com/"),
],
"show_breadcrumbs": True,
"switcher": {
Expand Down
8 changes: 4 additions & 4 deletions doc/source/contributing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ with this guide before attempting to contribute to the ``grantami-bomanalytics``
repository.

The following contribution information is specific to the ``grantami-bomanalytics``
repository, which is for the Granta MI BoM Analytics library. This PyAnsys library name
repository, which is for the PyGranta BoM Analytics library. This PyAnsys library name
is often used in place of the repository name to provide clarity and improve
readability.

Expand All @@ -35,10 +35,10 @@ this repository to submit questions, report bugs, and request new features.

To reach the PyAnsys support team, email `[email protected] <[email protected]>`_.

View Granta MI BoM Analytics documentation
View PyGranta BoM Analytics documentation
------------------------------------------
Documentation for the latest stable release of Granta MI BoM Analytics
is hosted at `Granta MI BoM Analytics Documentation <https://bomanalytics.grantami.docs.pyansys.com>`_.
Documentation for the latest stable release of PyGranta BoM Analytics
is hosted at `PyGranta BoM Analytics Documentation <https://bomanalytics.grantami.docs.pyansys.com>`_.

View examples
-------------
Expand Down
4 changes: 2 additions & 2 deletions doc/source/index.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
Granta MI BoM Analytics |version|
PyGranta BoM Analytics |version|
=================================

.. toctree::
Expand All @@ -20,7 +20,7 @@ For comprehensive API documentation, see :ref:`ref_grantami_bomanalytics_api_ind

Contributing
------------
Contributions to Granta MI BoM Analytics are welcomed. For more information, see
Contributions to PyGranta BoM Analytics are welcomed. For more information, see
:doc:`Contributing<contributing>`.

Project index
Expand Down
2 changes: 1 addition & 1 deletion doc/source/latexindex.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
:orphan:

Granta MI BoM Analytics API documentation
PyGranta BoM Analytics API documentation
=========================================

.. toctree::
Expand Down
2 changes: 1 addition & 1 deletion doc/styles/Vocab/ANSYS/accept.txt
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
ANSYS
Ansys
ansys
Granta MI BoM Analytics
PyGranta BoM Analytics
BoM
BoM Analytics
legislations
Expand Down