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

Fix breadcrumbs for v2.1 #3637

Conversation

carljparker
Copy link
Contributor

@carljparker carljparker commented Oct 5, 2023

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.
Screenshot 2023-10-05 at 4 47 25 PM
Screenshot 2023-10-05 at 4 45 13 PM

@pytorch-bot
Copy link

pytorch-bot bot commented Oct 5, 2023

🔗 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 Failures

As of commit 2f1163e with merge base e3b11a8 (image):
💚 Looks good so far! There are no failures yet. 💚

This comment was automatically generated by Dr. CI and updates every 15 minutes.

@carljparker carljparker marked this pull request as ready for review October 5, 2023 23:52
@carljparker carljparker requested a review from a team as a code owner October 5, 2023 23:52
@carljparker carljparker requested a review from mthrok October 5, 2023 23:53
@mthrok
Copy link
Collaborator

mthrok commented Oct 6, 2023

@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??

@facebook-github-bot
Copy link
Contributor

@carljparker has imported this pull request. If you are a Meta employee, you can view this diff on Phabricator.

@mthrok mthrok changed the title carljparker/fix breadcrumbs for v2.1 Fix breadcrumbs for v2.1 Oct 9, 2023
@facebook-github-bot facebook-github-bot merged commit a8bb397 into pytorch:main Oct 9, 2023
@github-actions
Copy link

github-actions bot commented Oct 9, 2023

Hey @None.
You merged this PR, but labels were not properly added. Please add a primary and secondary label (See https://github.com/pytorch/audio/blob/main/.github/process_commit.py).


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:

  • 'recipe' is applicable to training recipes under the 'examples' folder,
  • 'tutorial' is applicable to tutorials under the “examples/tutorials” folder
  • 'example' is applicable to everything else (e.g. C++ examples)
  • 'module: docs' is applicable to code documentations (not to tutorials).

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:
* Drop support of Python 3.7.
* Add support of Python 3.X.
* Change the way a third party library is bound (so that user needs to install it separately).

carljparker added a commit to carljparker/pytorch-audio that referenced this pull request Oct 10, 2023
Differential Revision: D50036850

Pull Request resolved: pytorch#3637
mthrok pushed a commit that referenced this pull request Oct 10, 2023
Differential Revision: D50036850

Pull Request resolved: #3637
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants