Skip to content
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

Jump to bottom

Update doc generation workflow #862

Merged
merged 42 commits into from
Oct 9, 2024
Merged

Update doc generation workflow #862

merged 42 commits into from
Oct 9, 2024

Conversation

keepingitneil
Copy link
Contributor

No description provided.

@changeset-bot changeset-bot
Copy link

changeset-bot bot commented Oct 7, 2024 •
edited
Loading

⚠️ No Changeset found

Latest commit: 501d114

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

theomonnom
theomonnom reviewed Oct 8, 2024
View reviewed changes
livekit-plugins/livekit-plugins-browser/livekit/plugins/browser/__init__.py Outdated
Comment on lines 31 to 38
# Cleanup docs of unexported modules
module = dir()
NOT_IN_ALL = [m for m in module if m not in __all__]

__pdoc__ = {}

for n in NOT_IN_ALL:
__pdoc__[n] = False
Copy link
Member

Choose a reason for hiding this comment

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

I'm curious if this is really needed.
https://pdoc3.github.io/pdoc/doc/pdoc/#what-objects-are-documented

Copy link
Contributor Author

Choose a reason for hiding this comment

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

It seems like pdoc if a directory has an init.py, pdoc is considering it a submodule. Even if it's not in all. Technically these modules are importable in a normal, non-package setup, so I guess it makes sense as a default behavior.

theomonnom
theomonnom reviewed Oct 9, 2024
View reviewed changes
.changeset/tame-cows-listen.md Outdated
Comment on lines 2 to 14
"livekit-agents": patch
"livekit-plugins-anthropic": patch
"livekit-plugins-azure": patch
"livekit-plugins-browser": patch
"livekit-plugins-cartesia": patch
"livekit-plugins-deepgram": patch
"livekit-plugins-elevenlabs": patch
"livekit-plugins-google": patch
"livekit-plugins-nltk": patch
"livekit-plugins-openai": patch
"livekit-plugins-playht": patch
"livekit-plugins-rag": patch
"livekit-plugins-silero": patch
Copy link
Member

Choose a reason for hiding this comment

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

No need to patch

Copy link
Member

Choose a reason for hiding this comment

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

Going to be noisy otherwise

@keepingitneil keepingitneil merged commit 8308729 into main Oct 9, 2024
5 of 8 checks passed
@keepingitneil keepingitneil deleted the neil/docs branch October 9, 2024 18:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@theomonnom theomonnom theomonnom approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@keepingitneil @theomonnom