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

readthedocs fails to auto-import API docs #894

Closed
ctb opened this issue Feb 8, 2020 · 6 comments
Closed

readthedocs fails to auto-import API docs #894

ctb opened this issue Feb 8, 2020 · 6 comments

Comments

@ctb
Copy link
Contributor

ctb commented Feb 8, 2020

See log file - the problem seems to be

WARNING: autodoc: failed to import module 'sourmash'; the following exception was raised:
No module named 'sourmash._lowlevel'

this is presumably because the rust stuff is not built?

@ctb
Copy link
Contributor Author

ctb commented Feb 8, 2020

ok, but it is built? odd. still looking.

@ctb
Copy link
Contributor Author

ctb commented Feb 8, 2020

even odder, it works on my test branch... https://sourmash.readthedocs.io/en/refactor-minhash/api.html

@luizirber
Copy link
Member

I think this is related to our non-src/ repo layout. I had similar issues in #696 (with coverage counting not lines in the installed package, but in the sourmash/ dir), and in this case it's because the sourmash package is being installed... but it's the sourmash/ dir that is being used during runtime.

Short term solution: install the package with -e . (and then _lowlevel.py will be available).

But I think we should move to src/ layout =]

@luizirber
Copy link
Member

Update: I don't think readthedocs supports -e . or develop installs...

@ctb
Copy link
Contributor Author

ctb commented Feb 23, 2020 via email

@ctb
Copy link
Contributor Author

ctb commented Jul 25, 2020

this seems to be working now. see: https://sourmash.readthedocs.io/en/latest/api.html

@ctb ctb closed this as completed Jul 25, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants