Skip to content

docs: readthedocs build fix #77

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.

Sign up for GitHub

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

Merged
choppsv1 merged 1 commit into from
Oct 11, 2025
Merged

docs: readthedocs build fix #77

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions readthedocs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,5 +8,7 @@ build:
# - pip install uv

@choppsv1 choppsv1 Oct 8, 2025

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Isn't this running in the munet workspace? Can we just use uv to install things?

Although, this is for producing the docs right? If it's not actually running munet, I'm not sure why we need to install munet at all.

@liambrady liambrady Oct 8, 2025

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is for producing the docs, correct.

Based on my limited understanding, uv does not support installing dependency groups into the workspaces using 'uv pip install', since they mirror the 'pip install' CLI. Maybe with the exception of the very latest versions of pip, you cannot requirements listed in dependency groups (e.g. 'dev' or 'ide' in the pyproject.yaml), so it is similarly not possible with uv.

Instead, you need to use something like 'uv sync --dev', which will install them to whatever workspace that uv has created.

Since it doesn't look like we are using the uv workspace (or uv at all, since you commented it out), I figured it is just simpler to install the dependency ourselves and move on.

@liambrady liambrady Oct 8, 2025

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Although, this is for producing the docs right? If it's not actually running munet, I'm not sure why we need to install munet at all.

Agreed, we might be able to get away with just installing sphinx and sphinx-prompt. Should I test that and update the readthedocs.yml file if it is successful?

@choppsv1 choppsv1 Oct 8, 2025

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If that works, sure.

@liambrady liambrady Oct 9, 2025

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks like the munet docstrings are referenced in order to build the API doc pages. They appear to pull from the installed munet version, so we can't get away with skipping the munet install.

post_install:
- pip install --editable .
# Installing from dependency groups (e.g. 'dev') is not yet supported.
- pip install sphinx-prompt
sphinx:
configuration: doc/source/conf.py
Loading