-
Notifications
You must be signed in to change notification settings - Fork 667
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
Fix breadcrumbs for v2.1 #3637
Fix breadcrumbs for v2.1 #3637
Conversation
🔗 Helpful Links🧪 See artifacts and rendered test results at hud.pytorch.org/pr/pytorch/audio/3637
Note: Links to docs will display an error until the docs builds have been completed. ✅ No FailuresAs of commit 2f1163e with merge base e3b11a8 (): This comment was automatically generated by Dr. CI and updates every 15 minutes. |
@carljparker Thanks for looking into this. I think this need to be documented as release process. To update the 2.1 stable doc do we need to cherry-pick this and rebuild the doc on release branch?? |
@carljparker has imported this pull request. If you are a Meta employee, you can view this diff on Phabricator. |
Hey @None. Some guidance:Use 'module: ops' for operations under 'torchaudio/{transforms, functional}', and ML-related components under 'torchaudio/csrc' (e.g. RNN-T loss). Things in "examples" directory:
Regarding examples in code documentations, please also use 'module: docs'. Please use 'other' tag only when you’re sure the changes are not much relevant to users, or when all other tags are not applicable. Try not to use it often, in order to minimize efforts required when we prepare release notes. When preparing release notes, please make sure 'documentation' and 'tutorials' occur as the last sub-categories under each primary category like 'new feature', 'improvements' or 'prototype'. Things related to build are by default excluded from the release note, except when it impacts users. For example: |
Differential Revision: D50036850 Pull Request resolved: pytorch#3637
Differential Revision: D50036850 Pull Request resolved: #3637
Change the stable version specified in
docs/source/conf.py
so that breadcrumbs display correctly on TorchAudio documentation pages. I tested on the nightly build using the docs build preview, and tested on the release by building locally on my MBP. See attached screenshots.