-
-
Notifications
You must be signed in to change notification settings - Fork 3.6k
Python 3.6: autodoc page builds locally, but is empty on readthedocs.org #7220
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
Comments
You need to have installed the same packages as you do locally, please check https://docs.readthedocs.io/en/stable/guides/specifying-dependencies.html#specifying-dependencies |
The package ukbiobank-tools appears to be installing successfully. I have managed to isolate this issue in the following way If I remove I.e. by commenting out the first line in ukbio.py
The following sphinx autodoc works:
However, this line is necessary for proper functioning of the ukbiobank-tools package. The thing that I can't understand is why when installing and building locally there appears to be no problem. It is not a case of sphinx not being able to install or see ukbiobank-tools , rather it appears to be cause by the importing within the ukbiobank-tools package. |
You can try mocking that package https://docs.readthedocs.io/en/stable/faq.html#my-project-isn-t-building-correctly |
I have managed to solve this now by fixing an issue with relative imports within the ukbiobank-tools python package. @stsewd Thank you very much for your help, I appreciate your fast responses. |
Details
Appears similar to the following issue #3634 , but not caused by the same issue seemingly.
Expected Result
I am attempting to build documentation for my project. When I build locally, autodoc produces API documentation, so I would expect that the same result on readthedocs.org, or that inspecting the build output for the project would reveal errors.
Actual Result
The build output provides the following:
The text was updated successfully, but these errors were encountered: