Skip to content

Commit

Permalink
switched to sphinx-design (#186) (#188)
Browse files Browse the repository at this point in the history
(cherry picked from commit 1a9c8ad)

Co-authored-by: Manoel Marques <manoelmrqs@gmail.com>
  • Loading branch information
mergify[bot] and manoelmarques committed Jun 29, 2022
1 parent 1c1fffb commit 0ada297
Show file tree
Hide file tree
Showing 3 changed files with 46 additions and 44 deletions.
6 changes: 3 additions & 3 deletions docs/conf.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# This code is part of Qiskit.
#
# (C) Copyright IBM 2021.
# (C) Copyright IBM 2021, 2022.
#
# This code is licensed under the Apache License, Version 2.0. You may
# obtain a copy of this license in the LICENSE.txt file in the root directory
Expand Down Expand Up @@ -99,7 +99,7 @@
"sphinx.ext.mathjax",
"sphinx.ext.viewcode",
"sphinx.ext.extlinks",
"sphinx_panels",
"sphinx_design",
"jupyter_sphinx",
"sphinx_autodoc_typehints",
"reno.sphinxext",
Expand Down Expand Up @@ -149,7 +149,7 @@
#
# This is also used if you do content translation via gettext catalogs.
# Usually you set "language" from the command line for these cases.
language = None
language = "en"

# For Adding Locale
locale_dirs = ["locale/"] # path is example but recommended.
Expand Down
82 changes: 42 additions & 40 deletions docs/getting_started.rst
Original file line number Diff line number Diff line change
Expand Up @@ -13,75 +13,77 @@ installation options for Qiskit and its supported environments/platforms. You sh
that first. Then the information here can be followed which focuses on the additional installation
specific to Qiskit Finance.

.. tabbed:: Start locally
.. tab-set::

The simplest way to get started is to follow the getting started 'Start locally' for Qiskit
here `Qiskit Getting Started <https://qiskit.org/documentation/getting_started.html>`__
.. tab-item:: Start locally

In your virtual environment where you installed Qiskit simply add ``finance`` to the
extra list in a similar manner to how the extra ``visualization`` support is installed for
Qiskit, i.e:
The simplest way to get started is to follow the getting started 'Start locally' for Qiskit
here `Qiskit Getting Started <https://qiskit.org/documentation/getting_started.html>`__

.. code:: sh
In your virtual environment where you installed Qiskit simply add ``finance`` to the
extra list in a similar manner to how the extra ``visualization`` support is installed for
Qiskit, i.e:

pip install qiskit[finance]
.. code:: sh
It is worth pointing out that if you're a zsh user (which is the default shell on newer
versions of macOS), you'll need to put ``qiskit[finance]`` in quotes:
pip install qiskit[finance]
.. code:: sh
It is worth pointing out that if you're a zsh user (which is the default shell on newer
versions of macOS), you'll need to put ``qiskit[finance]`` in quotes:

pip install 'qiskit[finance]'
.. code:: sh
pip install 'qiskit[finance]'
.. tabbed:: Install from source
Installing Qiskit Finance from source allows you to access the most recently
updated version under development instead of using the version in the Python Package
Index (PyPI) repository. This will give you the ability to inspect and extend
the latest version of the Qiskit Finance code more efficiently.
.. tab-item:: Install from source

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 <https://qiskit.org/documentation/getting_started.html>`__
Installing Qiskit Finance from source allows you to access the most recently
updated version under development instead of using the version in the Python Package
Index (PyPI) repository. This will give you the ability to inspect and extend
the latest version of the Qiskit Finance code more efficiently.

.. raw:: html
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 <https://qiskit.org/documentation/getting_started.html>`__

<h2>Installing Qiskit Finance from Source</h2>
.. raw:: html

Using the same development environment that you installed Qiskit in you are ready to install
Qiskit Finance.
<h2>Installing Qiskit Finance from Source</h2>

1. Clone the Qiskit Finance repository.
Using the same development environment that you installed Qiskit in you are ready to install
Qiskit Finance.

.. code:: sh
1. Clone the Qiskit Finance repository.

git clone https://github.com/Qiskit/qiskit-finance.git
.. code:: sh
2. Cloning the repository creates a local folder called ``qiskit-finance``.
git clone https://github.com/Qiskit/qiskit-finance.git
.. code:: sh
2. Cloning the repository creates a local folder called ``qiskit-finance``.

cd qiskit-finance
.. code:: sh
3. If you want to run tests or linting checks, install the developer requirements.
cd qiskit-finance
.. code:: sh
3. If you want to run tests or linting checks, install the developer requirements.

pip install -r requirements-dev.txt
.. code:: sh
4. Install ``qiskit-finance``.
pip install -r requirements-dev.txt
.. code:: sh
4. Install ``qiskit-finance``.

pip install .
.. code:: sh
If you want to install it in editable mode, meaning that code changes to the
project don't require a reinstall to be applied, you can do this with:
pip install .
.. code:: sh
If you want to install it in editable mode, meaning that code changes to the
project don't require a reinstall to be applied, you can do this with:

pip install -e .
.. code:: sh
pip install -e .
----

Expand Down
2 changes: 1 addition & 1 deletion requirements-dev.txt
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ stestr>=2.0.0
ddt>=1.2.0,!=1.4.0
reno>=3.4.0
Sphinx>=1.8.3,!=3.1.0
sphinx-panels
sphinx-design>=0.2.0
sphinx-gallery
sphinx-autodoc-typehints<1.14.0
sphinxcontrib-spelling
Expand Down

0 comments on commit 0ada297

Please sign in to comment.