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

Add config option to sphinx extension to blacklist datasets from showing example on the datacard #88

Open
hagenw opened this issue May 2, 2024 · 0 comments
Labels
enhancement New feature or request

Comments

@hagenw
Copy link
Member

hagenw commented May 2, 2024

At the moment, you can configure per TOC entry if audio examples should be shown on a datacard. In addition, they are only shown if a dataset contains a file that has at least one file with a duration of >0.5 s and <300s:

# Pick a meaningful duration for the example audio file
min_dur = 0.5
max_dur = 300 # 5 min

But you might still have the problem, that you have datasets that should not be accessibly by all users that can view a datacard. For those it would be good to disable showing an audio example. Another reason might be if all media files are stored in a single (or only a few) archives, as then the whole dataset needs to be downloaded in audb cache just to get a single media example.

To solve this, I would propose to add an config option, that a user can set inside docs/dong.py, e.g. audbcard_datasets_to_exclude_example.

@hagenw hagenw added the enhancement New feature or request label May 2, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant