Search code examples
pythonpython-sphinxread-the-docs

ReadTheDocs and autodoc fail to find my package during build

I have been trying to build docs on readthedocs for my debut python package QutiePy. Building the docs works fine locally, but when I try to build on readthedocs, autodoc fails to populate my sections and gives the following warning:

WARNING: autodoc: failed to import class 'main.register' from module 'QutiePy'; the following exception was raised:
No module named 'QutiePy'
WARNING: autodoc: failed to import module 'gates' from module 'QutiePy'; the following exception was raised:
No module named 'QutiePy'

I have tried many configurations of conf.py to try and add my package to PATH etc. but nothing I've tried has worked.

You can view the github repo I am using here, I am using the development branch.

Thanks in advance.

UPDATE: I have posted the RTD log here

UPDATE 2: I have posted the NEW RTD log here

Solution

  • The solution here was to check that my package was importable from PyPI, adding it to my requirements.txt and making sure that 'Install Project' was selected in the RTD advanced settings. I also added sphinxcontrib-napoleon to requirements.txt and imported it in conf.py although I am unsure if this plays a role at all.