.. QCircuits documentation master file, created by
   sphinx-quickstart on Fri Mar  8 23:21:44 2019.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Welcome to QCircuits's documentation
====================================

.. toctree::
   :maxdepth: 2
   :caption: Contents:

Repository at `github.com/grey-area/qcircuits <https://github.com/grey-area/qcircuits>`_.


Summary
=======

.. include:: ../../README.rst
  :start-after: inclusion-marker0-do-not-remove
  :end-before: inclusion-marker1-do-not-remove

Documentation, tutorial, and examples
=====================================

* :ref:`Tutorial<tutorial_page>`
* :ref:`Examples<examples_page>`
* :ref:`State module<state_module>`
* :ref:`Operators module<operators_module>`
* :ref:`Density operator module<density_operator_module>`
* :ref:`Tensors module<tensors_module>`
* :ref:`Change log<change_log>`

.. * :ref:`genindex`

.. include:: ../../README.rst
  :start-after: inclusion-marker1-do-not-remove
  :end-before: inclusion-marker15-do-not-remove

or from the source at `github.com/grey-area/qcircuits <https://github.com/grey-area/qcircuits>`_.

.. include:: ../../README.rst
  :start-after: inclusion-marker16-do-not-remove
  :end-before: inclusion-marker2-do-not-remove

See the :ref:`examples page<examples_page>` for more examples.

Quantum circuit:

.. image:: images/teleport.png
    :width: 90%

Code:

.. literalinclude:: ../../examples/quantum_teleportation.py

.. include:: ../../README.rst
  :start-after: inclusion-marker3-do-not-remove