-
-
Notifications
You must be signed in to change notification settings - Fork 145
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add Qibo conversions to documentation #2214
Conversation
Add Qibo conversions to documentation in API-Doc
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #2214 +/- ##
=======================================
Coverage 98.28% 98.28%
=======================================
Files 90 90
Lines 4259 4259
=======================================
Hits 4186 4186
Misses 73 73 ☔ View full report in Codecov by Sentry. |
Looks like Qibo is cut away in the RTD rendering of the Readme page. Trying to shrink all the logo sizes in the table to see if it works. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nice resizing of the logos, LGTM!
Docs build failure is unrelated (broken links). The "broken" links still work in Chrome, so I'm re-running the docs build to see if it was due to a temporary outage. Docs build ok now.
docs/source/apidoc.md
Outdated
#### Qibo Conversions | ||
|
||
```{eval-rst} | ||
.. automodule:: mitiq.interface.mitiq_qibo.conversions | ||
:members: | ||
``` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Question: There are a bunch of functions in this module that maybe don't need to go into the API-doc. E.g. all the ..._decomp
functions. Should we just have the to_qibo
and from_qibo
functions?
Thanks @natestemen, I've addressed the issue, it looks better now (preview). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
BTW @nathanshammah please try to use branch name that's descriptive of what the branch contains. A few ideas about how one can do this are available here. |
Add Qibo conversions to documentation in API-Doc and to Readme.