search

XanaduAI / strawberryfields

Strawberry Fields is a full-stack Python library for designing, simulating, and optimizing continuous variable (CV) quantum optical circuits.
https://strawberryfields.ai
Apache License 2.0
754 stars 191 forks source link

Fix docs building #424

Closed trbromley closed 4 years ago

trbromley commented 4 years ago

A new version of sphinx-autodoc-typehints was released yesterday that drops support for sphinx < 3.0. However, we currently version pin sphinx to 2.2.2.

This new release hence caused the documentation to stop building, and a quick fix is to version pin sphinx-autodoc-typehints to 1.10.3 as is done in this PR.

Current RTD builds are breaking: image

trbromley commented 4 years ago

Thanks @thisac!

I tried with sphinx==3.0.4 and sphinx==3.1.1 and got this error when building: TypeError: add_source_parser() takes 2 positional arguments but 3 were given

Not sure what the problem is :thinking:

codecov[bot] commented 4 years ago

Codecov Report

Merging #424 into master will increase coverage by 0.04%. The diff coverage is 99.17%.

@@            Coverage Diff             @@
##           master     #424      +/-   ##
==========================================
+ Coverage   97.84%   97.89%   +0.04%     
==========================================
  Files          58       67       +9     
  Lines        6784     6936     +152     
==========================================
+ Hits         6638     6790     +152     
  Misses        146      146
Impacted Files Coverage Δ
strawberryfields/api/result.py 100.00% <ø> (ø)
...awberryfields/backends/gaussianbackend/__init__.py 100.00% <ø> (ø)
strawberryfields/backends/gaussianbackend/ops.py 100.00% <ø> (+2.70%) :arrow_up:
strawberryfields/circuitspecs/gaussian_unitary.py 100.00% <ø> (ø)
strawberryfields/circuitspecs/tensorflow.py 100.00% <ø> (ø)
strawberryfields/backends/fockbackend/ops.py 94.04% <94.11%> (+2.04%) :arrow_up:
strawberryfields/ops.py 98.84% <96.29%> (-0.19%) :arrow_down:
strawberryfields/backends/tfbackend/ops.py 96.69% <97.88%> (-0.17%) :arrow_down:
strawberryfields/apps/data/feature.py 98.36% <98.36%> (ø)
strawberryfields/apps/__init__.py 100.00% <100.00%> (ø)
... and 39 more

Continue to review full report at Codecov.

Legend - Click here to learn more Δ = absolute <relative> (impact), ø = not affected, ? = missing data Powered by Codecov. Last update dfb1585...5aefac5. Read the comment docs.