CQCL / guppylang

Pythonic quantum-classical programming language
https://pypi.org/project/guppylang
Apache License 2.0
33 stars 3 forks source link

fix: Mock guppy decorator during sphinx builds #622

Closed mark-koch closed 2 weeks ago

mark-koch commented 2 weeks ago

Fixes #583

The problem was that sphinx autodoc got confused by @guppy decorated functions. Now, we mock the decorator when we detect that sphinx is running.

codecov-commenter commented 2 weeks ago

Codecov Report

Attention: Patch coverage is 53.48837% with 20 lines in your changes missing coverage. Please review.

Project coverage is 91.40%. Comparing base (45a460f) to head (05f92bf).

Files with missing lines Patch % Lines
guppylang/decorator.py 48.48% 17 Missing :warning:
guppylang/module.py 70.00% 3 Missing :warning:
Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #622 +/- ## ========================================== - Coverage 91.65% 91.40% -0.26% ========================================== Files 60 60 Lines 6448 6489 +41 ========================================== + Hits 5910 5931 +21 - Misses 538 558 +20 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.