Merge pull request #487 from qiboteam/doctest

adding doctest

.github/workflows/rules.yml

@@ -26,22 +26,27 @@ jobs:
       run: |
         python -m pip install --upgrade pip
         pip install pytest-cov
-        pip install .[tests]
+        pip install .[tests,docs]
         pip install qibotf
         pip install qibojit
     - name: Install package on Windows
       if: startsWith(matrix.os, 'windows')
       run: |
         python -m pip install --upgrade pip
         pip install pytest-cov
-        pip install .[qibojit,tests]
+        pip install .[qibojit,tests,docs]
     - name: Test with pylint
       run: |
         pip install pylint
         pylint src -E -d E1123,E1120
     - name: Test with pytest core
       run: |
         pytest --cov=qibo --cov-report=xml --pyargs qibo
+    - name: Test documentation examples
+      if: startsWith(matrix.os, 'ubuntu')
+      run: |
+        sudo apt install pandoc
+        make -C doc doctest
     - name: Test examples
       if: startsWith(matrix.os, 'ubuntu') && matrix.python-version == '3.9'
       run: |

doc/source/api-reference/qibo.rst

@@ -50,7 +50,12 @@ Circuit addition
 
 :class:`qibo.abstractions.circuit.AbstractCircuit` objects support addition. For example
 
-.. code-block::  python
+.. testsetup::
+
+    import qibo
+    qibo.set_backend("qibojit")
+
+.. testcode::
 
     from qibo import models
     from qibo import gates
@@ -91,7 +96,7 @@ round starts for the target qubits of the new two-qubit gate.
 
 For example the following:
 
-.. code-block::  python
+.. testcode::
 
     from qibo import models, gates
 
@@ -104,7 +109,7 @@ For example the following:
 will create a new circuit with a single :class:`qibo.abstractions.gates.FusedGate`
 acting on ``(0, 1)``, while the following:
 
-.. code-block::  python
+.. testcode::
 
     from qibo import models, gates
 
@@ -843,7 +848,7 @@ only supported by the native ``tensorflow`` backend.
 
 The user can switch backends using
 
-.. code-block::  python
+.. testcode::
 
     import qibo
     qibo.set_backend("qibotf")