Skip to content
This repository has been archived by the owner on Aug 19, 2023. It is now read-only.

Fix nested headers in getting started #1219

Merged
merged 3 commits into from
Apr 5, 2021
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
86 changes: 42 additions & 44 deletions docs/contributing_to_qiskit.rst
Original file line number Diff line number Diff line change
Expand Up @@ -805,85 +805,83 @@ using. Since Aer is a compiled C++ program with a Python interface, there are
non-Python dependencies for building the Aer binary which can't be installed
universally depending on operating system.

.. tabs::
.. tabbed:: Linux

.. tab:: Linux
3. Install compiler requirements.

3. Install compiler requirements.
Building Aer requires a C++ compiler and development headers.

Building Aer requires a C++ compiler and development headers.
If you're using Fedora or an equivalent Linux distribution,
install using:

If you're using Fedora or an equivalent Linux distribution,
install using:
.. code:: sh

.. code:: sh
dnf install @development-tools

dnf install @development-tools
For Ubuntu/Debian install it using:

For Ubuntu/Debian install it using:
.. code:: sh

.. code:: sh
apt-get install build-essential

apt-get install build-essential
4. Install OpenBLAS development headers.

4. Install OpenBLAS development headers.
If you're using Fedora or an equivalent Linux distribution,
install using:

If you're using Fedora or an equivalent Linux distribution,
install using:
.. code:: sh

.. code:: sh
dnf install openblas-devel

dnf install openblas-devel
For Ubuntu/Debian install it using:

For Ubuntu/Debian install it using:
.. code:: sh

.. code:: sh
apt-get install libopenblas-dev

apt-get install libopenblas-dev

.. tabbed:: macOS

.. tab:: macOS
3. Install dependencies.

3. Install dependencies.
To use the `Clang <https://clang.llvm.org/>`__ compiler on macOS, you need to install
an extra library for supporting `OpenMP <https://www.openmp.org/>`__. You can use `brew <https://brew.sh/>`__
to install this and other dependencies.

To use the `Clang <https://clang.llvm.org/>`__ compiler on macOS, you need to install
an extra library for supporting `OpenMP <https://www.openmp.org/>`__. You can use `brew <https://brew.sh/>`__
to install this and other dependencies.
.. code:: sh

.. code:: sh
brew install libomp

brew install libomp
4. Then install a BLAS implementation; `OpenBLAS <https://www.openblas.net/>`__
is the default choice.

4. Then install a BLAS implementation; `OpenBLAS <https://www.openblas.net/>`__
is the default choice.
.. code:: sh

.. code:: sh
brew install openblas

brew install openblas
Next, install ``Xcode Command Line Tools``.

Next, install ``Xcode Command Line Tools``.
.. code:: sh

.. code:: sh
xcode-select --install

xcode-select --install
.. tabbed:: Windows

.. tab:: Windows
On Windows you need to use `Anaconda3 <https://www.anaconda.com/distribution/#windows>`__
or `Miniconda3 <https://docs.conda.io/en/latest/miniconda.html>`__ to install all the
dependencies.

On Windows you need to use `Anaconda3 <https://www.anaconda.com/distribution/#windows>`__
or `Miniconda3 <https://docs.conda.io/en/latest/miniconda.html>`__ to install all the
dependencies.
3. Install compiler requirements.

3. Install compiler requirements.
.. code:: sh

.. code:: sh
conda install --update-deps vs2017_win-64 vs2017_win-32 msvc_runtime

conda install --update-deps vs2017_win-64 vs2017_win-32 msvc_runtime
4. Install binary and build dependencies.

4. Install binary and build dependencies.
.. code:: sh

.. code:: sh

conda install --update-deps -c conda-forge -y openblas cmake
conda install --update-deps -c conda-forge -y openblas cmake


5. Build and install qiskit-aer directly
Expand Down
35 changes: 21 additions & 14 deletions docs/getting_started.rst
Original file line number Diff line number Diff line change
Expand Up @@ -149,8 +149,9 @@ Installation
https://github.com/pypa/sample-namespace-packages/blob/master/table.md
for the set of combinations of installation methods that work together.

Set up the Virtual Development Environment
------------------------------------------
.. raw:: html

<h3>Set up the Virtual Development Environment</h3>

.. code-block:: sh

Expand All @@ -159,8 +160,9 @@ Installation

.. _install-qiskit-terra:

Installing Terra from Source
----------------------------
.. raw:: html

<h2>Installing Terra from Source</h2>

Installing from source requires that you have a C++ compiler on your system that supports
C++11.
Expand Down Expand Up @@ -261,8 +263,9 @@ Installation

.. _install-qiskit-aer:

Installing Aer from Source
--------------------------
.. raw:: html

<h2>Installing Aer from Source</h2>

1. Clone the Aer repository.

Expand Down Expand Up @@ -399,8 +402,9 @@ Installation

.. _aer_wheel_build_options:

Custom options during wheel builds
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. raw:: html

<h4>Custom options</h4>

The Aer build system uses `scikit-build <https://scikit-build.readthedocs.io/en/latest/index.html>`__
to run the compilation when building it with the Python interface. It acts as an interface for
Expand Down Expand Up @@ -478,8 +482,9 @@ Installation

.. _install-qiskit-ignis:

Installing Ignis from Source
----------------------------
.. raw:: html

<h2>Installing Ignis from Source</h2>

1. Clone the Ignis repository.

Expand Down Expand Up @@ -516,8 +521,9 @@ Installation

.. _install-qiskit-aqua:

Installing Aqua from Source
---------------------------
.. raw:: html

<h2>Installing Aqua from Source</h2>

1. Clone the Aqua repository.

Expand Down Expand Up @@ -554,8 +560,9 @@ Installation

.. _install-qiskit-ibmq-provider:

Installing IBM Quantum Provider from Source
-------------------------------------------
.. raw:: html

<h2>Installing IBM Quantum Provider from Source</h2>

1. Clone the qiskit-ibmq-provider repository.

Expand Down