From 6276e6a61a7296b3f36c1102c80807f404cf5746 Mon Sep 17 00:00:00 2001
From: vishal-ph <vishalsharma.ph@gmail.com>
Date: Fri, 11 Nov 2022 14:27:54 +0800
Subject: [PATCH] couple of cosmetic fixes to docs

---
 docs/source/backends.rst  | 64 ++++++++++++++++++++++-----------------
 docs/source/workflows.rst | 10 ++----
 2 files changed, 39 insertions(+), 35 deletions(-)

diff --git a/docs/source/backends.rst b/docs/source/backends.rst
index a4bb49840..8c1a9b10f 100644
--- a/docs/source/backends.rst
+++ b/docs/source/backends.rst
@@ -1,9 +1,16 @@
-Abstract Backends
+Base Backends and Device
 =================================
-.. .. autoclass:: openqaoa.basebackend.QuantumCircuitBase
-..     :members:
-..     :undoc-members:
-..     :inherited-members:
+
+BaseDevice
+----------
+
+.. autoclass:: openqaoa.devices.DeviceBase
+    :members:
+    :undoc-members:
+    :inherited-members:
+
+BaseBackends
+------------
 
 .. autoclass:: openqaoa.basebackend.VQABaseBackend
     :members:
@@ -36,58 +43,61 @@ Abstract Backends
     :inherited-members:
 
 
-Cloud Devices
+
+Cloud Backends and Devices
 =================================
-QCS - Rigetti
-----------------------------------
-.. autoclass:: openqaoa.backends.qpus.qaoa_pyquil_qpu.QAOAPyQuilQPUBackend
-    :members:
-    :undoc-members:
-    :inherited-members:
 
-IBM Quantum - IBM
-----------------------------------
-.. autoclass:: openqaoa.backends.qpus.qaoa_qiskit_qpu.QAOAQiskitQPUBackend
+Cloud Devices
+-------------
+
+.. autoclass:: openqaoa.devices.DeviceQiskit
     :members:
     :undoc-members:
     :inherited-members:
 
-Amazon Braket - Amazon
-----------------------------------
-.. autoclass:: openqaoa.backends.qpus.qaoa_braket_qpu.QAOAAWSQPUBackend
+.. autoclass:: openqaoa.devices.DevicePyquil
     :members:
     :undoc-members:
     :inherited-members:
 
-Devices
--------
-.. autoclass:: openqaoa.devices.DeviceBase
+.. autoclass:: openqaoa.devices.DeviceAWS
     :members:
     :undoc-members:
     :inherited-members:
 
-.. autoclass:: openqaoa.devices.DeviceLocal
+QCS - Rigetti
+-------------
+.. autoclass:: openqaoa.backends.qpus.qaoa_pyquil_qpu.QAOAPyQuilQPUBackend
     :members:
     :undoc-members:
     :inherited-members:
 
-.. autoclass:: openqaoa.devices.DeviceQiskit
+IBM Quantum - IBM
+-----------------
+.. autoclass:: openqaoa.backends.qpus.qaoa_qiskit_qpu.QAOAQiskitQPUBackend
     :members:
     :undoc-members:
     :inherited-members:
 
-.. autoclass:: openqaoa.devices.DevicePyquil
+Amazon Braket - Amazon
+----------------------
+.. autoclass:: openqaoa.backends.qpus.qaoa_braket_qpu.QAOAAWSQPUBackend
     :members:
     :undoc-members:
     :inherited-members:
 
-.. autoclass:: openqaoa.devices.DeviceAWS
+
+Local Backend and Devices --- Simulators
+========================================
+
+Local Device
+------------
+
+.. autoclass:: openqaoa.devices.DeviceLocal
     :members:
     :undoc-members:
     :inherited-members:
 
-Local devices --- Simulators
-=================================
 Vectorised
 ----------------------------------
 .. autoclass:: openqaoa.backends.simulators.qaoa_vectorized.QAOAvectorizedBackendSimulator
diff --git a/docs/source/workflows.rst b/docs/source/workflows.rst
index 4cb99eb4e..e88c88806 100644
--- a/docs/source/workflows.rst
+++ b/docs/source/workflows.rst
@@ -39,11 +39,8 @@ Workflow QAOA Parameters
     :inherited-members:
 
 
-
-
-Recursive QAOA
-===============
-
+RQAOA
+-----
 Recursive QAOA (RQAOA) is an iterative variant of QAOA, first introduced by Bravyi et. al in [1]. It runs QAOA recursively and uses the expectation values of the Hamiltonian terms to impose constraints and eliminate qubits for the problem at each step. Once the reduced problem reaches a preset cutoff size, it is solved exactly solved via classical methods. The final answer is then reconstructed by re-inserting the eliminated qubits in the classical solution in the appropriate order.
 
 We currently offer two flavors of RQAOA, both of which can be found in the ``rqaoa`` module:
@@ -56,9 +53,6 @@ The development of this method is associated with an internal research project a
 
 To choose the strategy, set the parameter ``rqaoa_type`` using the `set_rqaoa_parameters` method. To use the ``Adaptive`` strategy, pass ``rqaoa_type = 'adaptive'``. The default strategy is ``Custom``.
 
-
-RQAOA
------
 .. autoclass:: openqaoa.workflows.optimizer.RQAOA
     :members:
     :undoc-members: