Fix duplicate labels and other docs build warnings #9446
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
melissawm
requested review from
mikegre-google,
qihqi and
zhanyong-wan
as code owners
zhanyong-wan
approved these changes
Jul 7, 2025
qihqi
approved these changes
Jul 7, 2025
docs/source/contribute/plugins.md
Outdated
| @@ -45,7 +45,7 @@ you can test with the placeholder `LIBRARY` device type. For example: | |||
| [device(type='xla', index=0), device(type='xla', index=1), device(type='xla', index=2), device(type='xla', index=3)] | |||
|
|
|||
| To register your device type automatically for users as well as to | |||
| handle extra setup for e.g. multiprocessing, you may implement the | |||
| handle extra setup for e.g. multiprocessing, you may implement the | |||
auto-merge was automatically disabled
July 7, 2025 17:50
Head branch was pushed to by a user without write access
|
Thanks for the reviews - please let me know if I can address any other feedback. Cheers! |
|
@melissawm please rebase to head, we did some fix on the CI. thanks! |
melissawm
force-pushed
the
docs-build-warnings
branch
from
1a01be9 to
ed466c0
Compare
|
Done! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Closes #9256
One remaining question is if the removed empty html comment block can be safely removed.
The errors fixed by this PR are:
WARNING: duplicate labelxla/docs/source/contribute/plugins.md:68: ERROR: Unknown directive type "=html".xla/docs/source/learn/_pjrt.md: WARNING: document isn't included in any toctreexla/docs/source/learn/_pjrt.md:38: WARNING: 'myst' reference target not found: #multithreading-on-tpu-v2v3xla/docs/source/learn/_pjrt.md:400: WARNING: 'myst' reference target not found: ./ddp.mdxla/docs/source/learn/_pjrt.md:400: WARNING: 'myst' reference target not found: ../test/test_train_mp_imagenet.pyxla/docs/source/perf/spmd_advanced.md:6: WARNING: Non-consecutive header level increase; H1 to H3 [myst.header]xla/docs/source/perf/spmd_advanced.md:41: WARNING: Non-consecutive header level increase; H1 to H3 [myst.header]Some context:
autosectionlabelextension was clashing with the MyST default configuration. What changes is that MyST normalizes anchor labels so that# My Section Namehas a corresponding anchor of#my-section-name.spmd_advanced.mdfile, I'm not sure that this is the correct information organization, but it does match what is currently displayed on the live docs website.