Skip to content
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

Fix bug where quantum and samples were not showing up in the documentation #182

Merged
merged 1 commit into from
Jun 23, 2020

Conversation

josh146
Copy link
Member

@josh146 josh146 commented Jun 23, 2020

Context:

The quantum and samples modules were not showing up in the documentation, since dask was not being installed on readthedocs:

WARNING: autodoc: failed to import module 'quantum' from module 'thewalrus'; the following exception was raised:
No module named 'dask'
WARNING: autodoc: failed to import module 'samples' from module 'thewalrus'; the following exception was raised:
No module named 'dask'

Description of the Change: Adds dask[delayed] to docs/requirements.txt

Benefits: All modules now show in the build documentation.

Possible Drawbacks: Unfortunately, I can't build the documentation locally, I get a Segmentation Fault.

Related GitHub Issues: n/a

Comment on lines +51 to +52
/*box-shadow: 0 0px 0px 0 rgba(0,0,0,.05),0 30px 40px 0px rgba(0,0,0,.2) !important;*/
border-right: 1px #ddd solid;
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

(These stylistic changes are just to bring the theme in-line with the latest SF and PL documentation theme)

@codecov
Copy link

codecov bot commented Jun 23, 2020

Codecov Report

Merging #182 into master will not change coverage.
The diff coverage is n/a.

@@            Coverage Diff            @@
##            master      #182   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files           14        14           
  Lines         1062      1062           
=========================================
  Hits          1062      1062           

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 c35828f...24f97c1. Read the comment docs.

Copy link
Collaborator

@nquesada nquesada left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for fixing this @josh146

@nquesada nquesada self-requested a review June 23, 2020 13:42
@josh146 josh146 merged commit 9f2088f into master Jun 23, 2020
@nquesada nquesada deleted the fix-docs branch February 6, 2021 22:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants