diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 1f759d7..0f2874f 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -3,9 +3,9 @@ **We appreciate all kinds of help, so thank you!** First please read the overall project contributing guidelines. These are -included in the Qiskit documentation here: +included in the Qiskit project here: -https://qiskit.org/documentation/contributing_to_qiskit.html +https://github.com/Qiskit/qiskit/blob/main/CONTRIBUTING.md ## Contributing to Qiskit Finance @@ -61,8 +61,7 @@ please ensure that: to see the changes formatted output is as expected. You will find an index.html file in docs\_build\html and you can navigate from there. - Please note that a spell check is run in CI, on the docstrings, since the text - becomes part of the online [API Documentation](https://qiskit.org/documentation/). + Please note that a spell check is run in CI, on the docstrings. You can run `make spell` locally to check spelling though you would need to [install pyenchant](https://pyenchant.github.io/pyenchant/install.html) and be using diff --git a/docs/getting_started.rst b/docs/getting_started.rst index 620d2e7..906207e 100644 --- a/docs/getting_started.rst +++ b/docs/getting_started.rst @@ -8,7 +8,7 @@ Installation ============ Qiskit Finance depends on Qiskit, which has its own -`Qiskit Getting Started `__ detailing the +`installation instructions `__ detailing the installation options and its supported environments/platforms. You should refer to that first. Then the information here can be followed which focuses on the additional installation specific to Qiskit Finance. @@ -17,10 +17,9 @@ specific to Qiskit Finance. .. tab-item:: Start locally - The simplest way to get started is to first follow the `getting started 'Start locally' guide for - Qiskit `__ + The simplest way to get started is to follow the installation guide for Qiskit `here `__ - In your virtual environment, where you installed Qiskit, install Qiskit Finance as follows: + In your virtual environment, where you installed Qiskit, install ``qiskit-finance`` as follows: .. code:: sh @@ -41,7 +40,7 @@ specific to Qiskit Finance. Since Qiskit Finance depends on Qiskit, and its latest changes may require new or changed features of Qiskit, you should first follow Qiskit's `"Install from source"` instructions - here `Qiskit Getting Started `__ + `here `__ .. raw:: html diff --git a/setup.py b/setup.py index 55d6232..2307439 100644 --- a/setup.py +++ b/setup.py @@ -46,7 +46,7 @@ long_description_content_type="text/markdown", url='https://github.com/qiskit-community/qiskit-finance', author='Qiskit Finance Development Team', - author_email='hello@qiskit.org', + author_email='qiskit@us.ibm.com', license='Apache-2.0', classifiers=[ "Environment :: Console",