Fix nightly build of the staging cirq website (#6615)

- Fix syntax error in `docs/noise/_index.yaml` - Stop including deleted yaml file - Format with the yaml_format Google tool Fixes #6587
quantumlib · May 23, 2024 · e11d297 · e11d297
1 parent f246c2b
commit e11d297
Show file tree

Hide file tree

Showing 7 changed files with 267 additions and 247 deletions.
diff --git a/docs/_book.yaml b/docs/_book.yaml
@@ -22,8 +22,6 @@ upper_tabs:
 - name: "Software"
   path: /software
   is_default: true
-  menu:
-  - include: /_book/menu_software.yaml
   lower_tabs:
     # Subsite tabs
     other:

diff --git a/docs/build/_index.yaml b/docs/build/_index.yaml
@@ -4,46 +4,47 @@ title: Build a circuit
 landing_page:
   nav: left
   rows:
-    - heading: Build a circuit
-      description: At the core of Cirq is the ability to construct quantum circuits. These are the methods and data structures necessary to do so.
-    - heading: Circuit construction
-      description: The core data structures that compose a circuit and how to use them.
-      options:
-        - cards
-      items:
-      - heading: Circuits
-        description: Quantum circuits and how to create them.
-        path: /cirq/build/circuits
-      - heading: Qubits
-        description: The quantum bit data structure.
-        path: /cirq/build/qubits
-      - heading: Gates and Operations
-        description: Quantum gates to apply to qubits in a circuit.
-        path: /cirq/build/gates
-      - heading: Custom gates
-        description: Create your own gates with unitaries or decomposition.
-        path: /cirq/build/custom_gates
-      - heading: Import/export circuits
-        description: Importing or exporting circuits into/out of Cirq.
-        path: /cirq/build/interop
+  - heading: Build a circuit
+    description: At the core of Cirq is the ability to construct quantum circuits.
+      These are the methods and data structures necessary to do so.
+  - heading: Circuit construction
+    description: The core data structures that compose a circuit and how to use them.
+    options:
+    - cards
+    items:
+    - heading: Circuits
+      description: Quantum circuits and how to create them.
+      path: /cirq/build/circuits
+    - heading: Qubits
+      description: The quantum bit data structure.
+      path: /cirq/build/qubits
+    - heading: Gates and Operations
+      description: Quantum gates to apply to qubits in a circuit.
+      path: /cirq/build/gates
+    - heading: Custom gates
+      description: Create your own gates with unitaries or decomposition.
+      path: /cirq/build/custom_gates
+    - heading: Import/export circuits
+      description: Importing or exporting circuits into/out of Cirq.
+      path: /cirq/build/interop
 
-    - heading: Advanced construction
-      description: More elaborate ways to build quantum circuits.
-      options:
-        - cards
-      items:
-      - heading: Operators
-        description: Unitary operators, measurements and noise channels.
-        path: /cirq/build/operators
-      - heading: Observables and PauliStrings
-        description: Build and measure observables from sums and products of Pauli operators.
-        path: /cirq/build/pauli_observables
-      - heading: Qudits
-        description: Qutrits and higher dimensional quantum systems.
-        path: /cirq/build/qudits
-      - heading: Protocols
-        description: Magic methods supported by Cirq's classes.
-        path: /cirq/build/protocols
-      - heading: Tools ecosystem
-        description: External tools for circuit construction.
-        path: /cirq/build/ecosystem
+  - heading: Advanced construction
+    description: More elaborate ways to build quantum circuits.
+    options:
+    - cards
+    items:
+    - heading: Operators
+      description: Unitary operators, measurements and noise channels.
+      path: /cirq/build/operators
+    - heading: Observables and PauliStrings
+      description: Build and measure observables from sums and products of Pauli operators.
+      path: /cirq/build/pauli_observables
+    - heading: Qudits
+      description: Qutrits and higher dimensional quantum systems.
+      path: /cirq/build/qudits
+    - heading: Protocols
+      description: Magic methods supported by Cirq's classes.
+      path: /cirq/build/protocols
+    - heading: Tools ecosystem
+      description: External tools for circuit construction.
+      path: /cirq/build/ecosystem
diff --git a/docs/experiments/_index.yaml b/docs/experiments/_index.yaml
@@ -4,37 +4,43 @@ title: Experiments using quantum circuits
 landing_page:
   nav: left
   rows:
-    - heading: Experiments using quantum circuits
-      description: This is a collection of algorithms and experiments written in and using Cirq. A couple of them use only base Cirq, but the rest use additional code stored in ReCirq, a GitHub repository for research code that uses and builds upon Cirq.
-    - buttons:
-      - label: Cirq GitHub
-        path: https://github.com/quantumlib/Cirq
-      - label: ReCirq GitHub
-        path: https://github.com/quantumlib/ReCirq
-    - heading: Algorithms in base Cirq
-      description: Algorithms and experiments executable using only default Cirq code.
-      options:
-        - cards
-      items:
-      - heading: Textbook Algorithms Workshop
-        description: A workshop notebook with examples that covers algorithms commonly shown in quantum textbooks.
-        path: /cirq/experiments/textbook_algorithms
-      - heading: Shor's Algorithm
-        description: The famous integer factorization algorithm by Peter Shor.
-        path: /cirq/experiments/shor
-      - heading: Variational Quantum Eigensolver
-        description: Compute the ground state of a Hamiltonian using the variational principle.
-        path: /cirq/experiments/variational_algorithm
-      - heading: Quantum Walks
-        description: The quantum analog of a random walk algorithm.
-        path: /cirq/experiments/quantum_walks
-      - heading: Fourier Checking
-        description: Demonstrate the separation between quantum and classical computers.
-        path: /cirq/experiments/fourier_checking
-      - heading: Hidden Linear Function problem
-        description: Show quantum separation with a constant depth solution.
-        path: /cirq/experiments/hidden_linear_function
+  - heading: Experiments using quantum circuits
+    description: This is a collection of algorithms and experiments written in and
+      using Cirq. A couple of them use only base Cirq, but the rest use additional
+      code stored in ReCirq, a GitHub repository for research code that uses and builds
+      upon Cirq.
+  - buttons:
+    - label: Cirq GitHub
+      path: https://github.com/quantumlib/Cirq
+    - label: ReCirq GitHub
+      path: https://github.com/quantumlib/ReCirq
+  - heading: Algorithms in base Cirq
+    description: Algorithms and experiments executable using only default Cirq code.
+    options:
+    - cards
+    items:
+    - heading: Textbook Algorithms Workshop
+      description: A workshop notebook with examples that covers algorithms commonly
+        shown in quantum textbooks.
+      path: /cirq/experiments/textbook_algorithms
+    - heading: Shor's Algorithm
+      description: The famous integer factorization algorithm by Peter Shor.
+      path: /cirq/experiments/shor
+    - heading: Variational Quantum Eigensolver
+      description: Compute the ground state of a Hamiltonian using the variational
+        principle.
+      path: /cirq/experiments/variational_algorithm
+    - heading: Quantum Walks
+      description: The quantum analog of a random walk algorithm.
+      path: /cirq/experiments/quantum_walks
+    - heading: Fourier Checking
+      description: Demonstrate the separation between quantum and classical computers.
+      path: /cirq/experiments/fourier_checking
+    - heading: Hidden Linear Function problem
+      description: Show quantum separation with a constant depth solution.
+      path: /cirq/experiments/hidden_linear_function
 
-    - heading: ReCirq Experiments
-      description: Research experiments that use additional library code that resides in the external ReCirq repository.
-    - include: /cirq/experiments/_index_included.yaml
+  - heading: ReCirq Experiments
+    description: Research experiments that use additional library code that resides
+      in the external ReCirq repository.
+  - include: /cirq/experiments/_index_included.yaml
diff --git a/docs/hardware/_index.yaml b/docs/hardware/_index.yaml
@@ -4,101 +4,105 @@ title: Hardware
 landing_page:
   nav: left
   rows:
-    - heading: Represent a quantum hardware device
-      description: Define the characteristics and constraints of quantum hardware devices, to support running circuits on those devices.
-      options:
-        - cards
-      items:
-      - heading: Devices
-        description: Represent the constraints a device imposes on runnable circuits with the Device class.
-        path: /cirq/hardware/devices
+  - heading: Represent a quantum hardware device
+    description: Define the characteristics and constraints of quantum hardware devices,
+      to support running circuits on those devices.
+    options:
+    - cards
+    items:
+    - heading: Devices
+      description: Represent the constraints a device imposes on runnable circuits
+        with the Device class.
+      path: /cirq/hardware/devices
 
-    - heading: Run a circuit on a hardware device
-      description: Cirq provides interfaces for running your circuits on quantum hardware provided by many different services.
-      options:
-        - cards
-      items:
-      - heading: Qubit Picking
-        description: Information to help you pick good qubits for running your circuit on a hardware or hardware-like device.
-        path: /cirq/hardware/qubit_picking
+  - heading: Run a circuit on a hardware device
+    description: Cirq provides interfaces for running your circuits on quantum hardware
+      provided by many different services.
+    options:
+    - cards
+    items:
+    - heading: Qubit Picking
+      description: Information to help you pick good qubits for running your circuit
+        on a hardware or hardware-like device.
+      path: /cirq/hardware/qubit_picking
 
-    - heading: AQT hardware
-      description: Cirq's interface with Alpine Quantum Technologies hardware.
-      options:
-        - cards
-      items:
-      - heading: Access and authentication
-        description: How to gain access.
-        path: /cirq/hardware/aqt/access
-      - heading: Getting started with AQT hardware
-        description: How to run your first circuit.
-        path: /cirq/hardware/aqt/getting_started
+  - heading: AQT hardware
+    description: Cirq's interface with Alpine Quantum Technologies hardware.
+    options:
+    - cards
+    items:
+    - heading: Access and authentication
+      description: How to gain access.
+      path: /cirq/hardware/aqt/access
+    - heading: Getting started with AQT hardware
+      description: How to run your first circuit.
+      path: /cirq/hardware/aqt/getting_started
 
-    - heading: Azure Quantum
-      description: Cirq's interface with Microsoft Azure Quantum services.
-      options:
-        - cards
-      items:
-      - heading: Access and authentication
-        description: How to gain access.
-        path: /cirq/hardware/azure-quantum/access
-      - heading: Getting started with Honeywell on AQT hardware
-        description: How to run your first circuit on a Honeywell device.
-        path: /cirq/hardware/azure-quantum/getting_started_honeywell
-      - heading: Getting started with IonQ on AQT hardware
-        description: How to run your first circuit on an IonQ device.
-        path: /cirq/hardware/azure-quantum/getting_started_ionq
+  - heading: Azure Quantum
+    description: Cirq's interface with Microsoft Azure Quantum services.
+    options:
+    - cards
+    items:
+    - heading: Access and authentication
+      description: How to gain access.
+      path: /cirq/hardware/azure-quantum/access
+    - heading: Getting started with Honeywell on AQT hardware
+      description: How to run your first circuit on a Honeywell device.
+      path: /cirq/hardware/azure-quantum/getting_started_honeywell
+    - heading: Getting started with IonQ on AQT hardware
+      description: How to run your first circuit on an IonQ device.
+      path: /cirq/hardware/azure-quantum/getting_started_ionq
 
-    - heading: IonQ hardware
-      description: Cirq's interface with IonQ hardware.
-      options:
-        - cards
-      items:
-      - heading: Access and authentication
-        description: How to gain access.
-        path: /cirq/hardware/ionq/access
-      - heading: Getting started with IonQ hardware
-        description: How to run your first circuit.
-        path: /cirq/hardware/ionq/getting_started
-      - heading: IonQ API Service
-        description: Using the IonQ API.
-        path: /cirq/hardware/ionq/service
-      - heading: IonQ API circuits
-        description: Writing circuits for the IonQ API.
-        path: /cirq/hardware/ionq/circuits
-      - heading: Running IonQ API jobs
-        description: How to run jobs with the IonQ API.
-        path: /cirq/hardware/ionq/jobs
-      - heading: IonQ API calibrations
-        description: How to get hardware device calibration data through the IonQ API.
-        path: /cirq/hardware/ionq/calibrations
+  - heading: IonQ hardware
+    description: Cirq's interface with IonQ hardware.
+    options:
+    - cards
+    items:
+    - heading: Access and authentication
+      description: How to gain access.
+      path: /cirq/hardware/ionq/access
+    - heading: Getting started with IonQ hardware
+      description: How to run your first circuit.
+      path: /cirq/hardware/ionq/getting_started
+    - heading: IonQ API Service
+      description: Using the IonQ API.
+      path: /cirq/hardware/ionq/service
+    - heading: IonQ API circuits
+      description: Writing circuits for the IonQ API.
+      path: /cirq/hardware/ionq/circuits
+    - heading: Running IonQ API jobs
+      description: How to run jobs with the IonQ API.
+      path: /cirq/hardware/ionq/jobs
+    - heading: IonQ API calibrations
+      description: How to get hardware device calibration data through the IonQ API.
+      path: /cirq/hardware/ionq/calibrations
 
-    - heading: Pasqal hardware
-      description: Cirq's interface with Pasqal hardware.
-      options:
-        - cards
-      items:
-      - heading: Access and authentication
-        description: How to gain access.
-        path: /cirq/hardware/pasqal/access
-      - heading: Getting started with Pasqal hardware
-        description: How to run your first circuit.
-        path: /cirq/hardware/pasqal/getting_started
-      - heading: Pasqal devices
-        description: Device objects to specify Pasqal hardware.
-        path: /cirq/hardware/pasqal/devices
-      - heading: Pasqal sampler
-        description: Sampler objects to run on Pasqal hardware.
-        path: /cirq/hardware/pasqal/sampler
+  - heading: Pasqal hardware
+    description: Cirq's interface with Pasqal hardware.
+    options:
+    - cards
+    items:
+    - heading: Access and authentication
+      description: How to gain access.
+      path: /cirq/hardware/pasqal/access
+    - heading: Getting started with Pasqal hardware
+      description: How to run your first circuit.
+      path: /cirq/hardware/pasqal/getting_started
+    - heading: Pasqal devices
+      description: Device objects to specify Pasqal hardware.
+      path: /cirq/hardware/pasqal/devices
+    - heading: Pasqal sampler
+      description: Sampler objects to run on Pasqal hardware.
+      path: /cirq/hardware/pasqal/sampler
 
-    - heading: Rigetti hardware
-      description: Cirq's interface with Rigetti hardware.
-      options:
-        - cards
-      items:
-      - heading: Access and authentication
-        description: How to gain access.
-        path: /cirq/hardware/rigetti/access
-      - heading: Getting started with Rigetti hardware
-        description: How to run your first circuit.
-        path: /cirq/hardware/rigetti/getting_started
+  - heading: Rigetti hardware
+    description: Cirq's interface with Rigetti hardware.
+    options:
+    - cards
+    items:
+    - heading: Access and authentication
+      description: How to gain access.
+      path: /cirq/hardware/rigetti/access
+    - heading: Getting started with Rigetti hardware
+      description: How to run your first circuit.
+      path: /cirq/hardware/rigetti/getting_started