qiboteam / qibosoq

Qibo server for Qick
https://qibo.science
Apache License 2.0
12 stars 3 forks source link

Add automated `apidoc` #58

Closed alecandido closed 1 year ago

alecandido commented 1 year ago

Apidoc added

Checklist before merge:

codecov-commenter commented 1 year ago

Codecov Report

Patch and project coverage have no change.

Comparison is base (a17a09c) 72.42% compared to head (4ee1fa1) 72.42%.

Additional details and impacted files ```diff @@ Coverage Diff @@ ## update-docs #58 +/- ## ============================================ Coverage 72.42% 72.42% ============================================ Files 11 11 Lines 544 544 ============================================ Hits 394 394 Misses 150 150 ``` | Flag | Coverage Δ | | |---|---|---| | unittests | `72.42% <ø> (ø)` | | Flags with carried forward coverage won't be shown. [Click here](https://docs.codecov.io/docs/carryforward-flags?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=qiboteam#carryforward-flags-in-the-pull-request-comment) to find out more.

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Do you have feedback about the report comment? Let us know in this issue.

alecandido commented 1 year ago

We should tell pydocstyle to only have a look inside src/...

(but I can also provide a minimal docstring for the conf.py function, all in all it's not a bad idea)

rodolfocarobene commented 1 year ago

Thanks @AleCandido

We should tell pydocstyle to only have a look inside src/... (but I can also provide a minimal docstring for the conf.py function, all in all it's not a bad idea)

I think a super-minimal docstring is nice :-)

alecandido commented 1 year ago

As usual, I'd merge this after #52 and #57