Skip to content

readthedocs: fix doc build failures #65

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Conversation

liambrady
Copy link
Contributor

@liambrady liambrady commented Jun 26, 2025

For some reason, poetry does not install dependencies to the correct site-package in the read the docs enviornment. As a temporary fix, we can pip freeze the packages that poetry installs within a venv and reinstall them to the correct site-packages by directly using pip.

I don't think it is worth it to investigate and determine a permanent fix given the ongoing discussion of swapping out poetry with uv.

@liambrady liambrady requested a review from choppsv1 June 26, 2025 13:08
@liambrady liambrady force-pushed the liambrady/docs_fix branch from 38f7f0e to c986f3c Compare June 26, 2025 13:10
@liambrady liambrady changed the title docs: fix doc build failures readthedocs: fix doc build failures Jun 26, 2025
For some reason, poetry does not install dependencies
to the correct site-package in the read the docs. As
a temporary fix, we can `pip freeze` the packages that
poetry installs and reinstall them to the correct
site-packages by directly using pip.

Signed-off-by: Liam Brady <[email protected]>
@liambrady liambrady force-pushed the liambrady/docs_fix branch from c986f3c to e42b903 Compare June 26, 2025 13:12
@liambrady liambrady added the documentation Improvements or additions to documentation label Jun 26, 2025
@liambrady
Copy link
Contributor Author

link to the (hidden) docs built through this PR: https://munet.readthedocs.io/en/liambrady-docs_fix/

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant