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.

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

Set a environment variable to indicate when running quartodoc build #324

Open
machow opened this issue Jan 17, 2024 · 0 comments
Open

Set a environment variable to indicate when running quartodoc build #324

machow opened this issue Jan 17, 2024 · 0 comments
Labels
api:builder time:short Takes an hour or less to resolve

Comments

@machow
Copy link
Owner

machow commented Jan 17, 2024

from @gadenbuie, pkgdown sets the environment variable IN_PKGDOWN="true" when running. We could similarly set an environment variable.

This is useful for packages that dynamically modify docstrings (or other behavior), but only when generating API docs. For example, plotnine has a bunch of example notebooks it attaches, and py-shiny has shinylive examples it attaches to API docs.

@machow machow added api:builder time:short Takes an hour or less to resolve labels Aug 20, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
api:builder time:short Takes an hour or less to resolve
Projects
Status: Todo
Development

No branches or pull requests

1 participant