Update docs after install overhaul#469
Merged
Merged
Conversation
Keep the contributing guide in the repository root so it is easier to find in local checkouts and the GitHub file browser. GitHub recognizes root CONTRIBUTING.md for contributor prompts, so the move preserves the existing GitHub behavior.
The Sphinx API docs recursively import openlifu modules. After the optional-dependency split, the docs environment needs the mesh, db, and cloud extras so those imports resolve during autosummary generation without pulling in simulation binaries or hardware SDK dependencies.
peterhollender
approved these changes
Jun 12, 2026
peterhollender
left a comment
peterhollender
left a comment
Contributor
There was a problem hiding this comment.
Reasonable updates
Contributor
|
Sorry. A little behind on the review, but this is excellent. Thanks!
…On Fri, Jun 12, 2026 at 8:37 AM Ebrahim Ebrahim ***@***.***> wrote:
Merged #469 <#469>
into main.
—
Reply to this email directly, view it on GitHub
<#469?email_source=notifications&email_token=B2NNIMUWXMQS72VSSLSZLD347QPVDA5CNFSNUABQM5UWIORPF5TWS5BNNB2WEL2JONZXKZKFOZSW45CON52GSZTJMNQXI2LPNYXTENRWHAZDMNRZG4ZDHJTSMVQXG33OU5WWK3TUNFXW5JLFOZSW45FMMZXW65DFOJPWG3DJMNVQ#event-26682669723>,
or unsubscribe
<https://github.com/notifications/unsubscribe-auth/B2NNIMRKQXPRPCGI7ATGW2D47QPVDAVCNFSNUABFKJSXA33TNF2G64TZHM3TCMRVHA3TIMRWHNEXG43VMU5TINRUGE4DQMJZGEY2C5QC>
.
Triage notifications, keep track of coding agent tasks and review pull
requests on the go with GitHub Mobile for iOS
<https://github.com/notifications/mobile/ios/B2NNIMV5I3LNPXHAUMVDBBD47QPVDA5CNFSNUABQM5UWIORPF5TWS5BNNB2WEL2JONZXKZKFOZSW45CON52GSZTJMNQXI2LPNYXTENRWHAZDMNRZG4ZDHJTSMVQXG33OU5WWK3TUNFXW5JLFOZSW45FKMZXW65DFOJPWS33T>
and Android
<https://github.com/notifications/mobile/android/B2NNIMWEASG4OJ5O6VHMVF347QPVDA5CNFSNUABQM5UWIORPF5TWS5BNNB2WEL2JONZXKZKFOZSW45CON52GSZTJMNQXI2LPNYXTENRWHAZDMNRZG4ZDHJTSMVQXG33OU5WWK3TUNFXW5JLFOZSW45FOMZXW65DFOJPWC3TEOJXWSZA>.
Download it today!
You are receiving this because you were mentioned.Message ID:
***@***.***
com>
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Update docs after #444
The main changes that happened to the docs are easiest to see in commit 966ce87
The new README can be previewed here: https://github.com/OpenwaterHealth/openlifu-python/blob/update-docs-after-install-overhaul/README.md
Now there's a "recommended isntall" and "minimal install" and "install with selected features"
While I was at it, I made a few other unrelated changes that were bugging me: