Fix Documentation corresponding to new plugin restructure - Githubissues

entropicalabs / openqaoa

Multi-backend SDK for quantum optimisation

MIT License

113 stars 59 forks source link

Fix Documentation corresponding to new plugin restructure #248

Closed vishal-ph closed 1 year ago

vishal-ph commented 1 year ago

Description

This PR implements updates to READMEs and docs for the plugin restructure of OpenQAOA.
The documentation now supports separate API reference for each plugin package.
TODO: fix notebooks according to each package

Checklist

[x] I have performed a self-review of my code.
[x] I have commented my code and used numpy-style docstrings
[x] I have made corresponding updates to the documentation.
[x] My changes generate no new warnings
[x] I have added/updated tests to make sure bugfix/feature works.
[x] New and existing unit tests pass locally with my changes.

Type of change

Please delete options that are not relevant.

[x] Breaking change (fix or feature that would cause existing functionality not to work as expected)