Directives

The Xanadu Sphinx Theme implements the custom Sphinx directives listed below. For more information, consult the relevant Python module in the directives package.

Community Card

.. community-card::
    :title: Weighted SubSpace QAOA to find maximum graph cliques
    :date: 03/07/2022
    :author: John Smith, Jane Doe
    :paper: https://example.com
    :code: https://code.com

    An explanation of the work.

Weighted SubSpace QAOA to find maximum graph cliques

John Smith, Jane Doe

03/07/2022

An explanation of the work.

Read More

Paper Code

Weighted SubSpace QAOA to find maximum graph cliques

×

An explanation of the work.

Paper Code

Details Dropdown

.. details::
    :title: Important Details
    :href: important-details

    In general, the block takes D parameters and **must** have the following signature:

    .. code-block:: python

        unitary(parameter1, parameter2, ... parameterD, wires)

    For a block with multiple parameters, ``n_params_block`` is equal to the number of parameters in ``block``.
    For a block with a single parameter, ``n_params_block`` is equal to the length of the parameter array.

.. details::
    :title: Usage Details

    This function can be used with any of the supported autodifferentiation frameworks. It also supports
    just-in-time compilation with JAX:

    .. code-block:: python

        jax.jit(unitary)(parameter1, parameter2, ... parameterD, wires)

Example:

Important Details

In general, the block takes D parameters and must have the following signature:

unitary(parameter1, parameter2, ... parameterD, wires)

For a block with multiple parameters, n_params_block is equal to the number of parameters in block. For a block with a single parameter, n_params_block is equal to the length of the parameter array.

Usage Details

This function can be used with any of the supported autodifferentiation frameworks. It also supports just-in-time compilation with JAX:

jax.jit(unitary)(parameter1, parameter2, ... parameterD, wires)

Gallery Item

.. gallery-item::
    :description: :doc:`Getting Started <started>`
    :figure: :figure: _static/teleport.png

.. raw:: html

    <div style='clear:both'>

Getting Started

Index Card

.. index-card::
    :name: Using the theme
    :link: started.html
    :description: Get started using the Xanadu Sphinx theme

Using the theme

Get started using the Xanadu Sphinx theme

Related

.. related::

   elements View elements
   configuration View configuration options

This adds a ‘Related’ section, with links to content, to the local table of contents on the right.

Title Card

.. title-card::
    :name: 'lightning.qubit'
    :description: A fast state-vector qubit simulator written in C++
    :link: https://docs.pennylane.ai/projects/lightning

.. raw:: html

    <div style='clear:both'>

'lightning.qubit'

A fast state-vector qubit simulator written in C++

YouTube Video

.. youtube-video:: WOLzqeuXVT8
    :title: PennyLane, a framework for quantum programming
    :author: Xanadu, a Toronto-based quantum computing company

PennyLane, a framework for quantum programming

Xanadu, a Toronto-based quantum computing company

---

Watch

Quantum Computational Advantage with Borealis

Xanadu, a Toronto-based quantum computing company

---

Watch

Author bio

.. bio:: John Smith
    :photo: _static/teleport.png

    Write the author bio content here. It must be preceded by a blank line.

John Smith

Write the author bio content here. It must be preceded by a blank line.

directives

 

Download Python script

 

Download Notebook

 

View on GitHub