Docs build fail locally with library installed in editable mode

[thehomebrewnerd]

Describe the bug

When building the Featuretools docs locally with Featuretools installed in editable mode, the docs build fails. If Featuretools is installed in non-editable mode the docs build fine.

The issue seems to be the same as the one originally raised in this Stack Overflow question, but the solution mentioned in the comments there does not apply to Featuretools.

All the unit tests pass fine in editable mode, and this issue has only been observed when building the docs locally.

How to Reproduce

The best way I know how to illustrate this is to run the Featuretools documentation build process locally.

git clone https://github.com/alteryx/featuretools.git
cd featuretools
# Make a virtual env
python3.8 -m venv env
source env/bin/activate

# install Featuretools and dependencies in editable mode
make installdeps

# Try to run docs build
cd docs
make clean
make html

When I do these steps, multiple errors of this form are reported:

Possible hints:
* KeyError: 'Relationship'
* ModuleNotFoundError: No module named 'Relationship'
* AttributeError: module 'featuretools.entityset.Relationship' has no attribute 'child_dataframe'
* ImportError:
* ModuleNotFoundError: No module named 'featuretools.entityset.Relationship.child_dataframe'; 'featuretools.entityset.Relationship' is not a package

Environment Information

ERROR: HTTP error 404 while getting https://github.com/AA-Turner/sphinx/archive/refs/heads/5.x.zip ERROR: Could not install requirement https://github.com/AA-Turner/sphinx/archive/refs/heads/5.x.zip because of HTTP error 404 Client Error: Not Found for url: https://codeload.github.com/AA-Turner/sphinx/zip/refs/heads/5.x for URL https://github.com/AA-Turner/sphinx/archive/refs/heads/5.x.zip

Sphinx extensions

No response

Additional context

No response

[AA-Turner]

This feels like a PYTHONPATH error, can you try running in isolated mode?

A

[thehomebrewnerd]

@AA-Turner I might not be quite understanding, but I tried running this:

python -I -m sphinx -b html -d build/doctrees source build/html 

instead of

sphinx-build -b html -d build/doctrees source build/html 

I got the same errors in both cases. Is that what you were suggesting? Also, I am running everything inside a virtual environment created with python -m venv env.

[thehomebrewnerd]

FWIW this issue might be specific to mac installs. The docs appear to build fine on ubuntu and debian, but not on macOS Monterey. Builds on a new M1 mac and an older x86 mac both fail, both running Monterey.

[Eric-Arellano]

Hi @AA-Turner, was this closed due to a recent change to Sphinx?

[AA-Turner]

I closed as I don't have a good fix for it and I'm not conviced the issue lies with Sphinx -- we've a large pile of issues and I've been trying to close low priority / ones that I don't see how Sphinx can solve. Sorry not to have better news.

A