Skip to content

Fix duplicate labels and other docs build warnings#9446

Merged
qihqi merged 2 commits intopytorch:masterfrom
melissawm:docs-build-warnings
Jul 16, 2025
Merged

Fix duplicate labels and other docs build warnings#9446
qihqi merged 2 commits intopytorch:masterfrom
melissawm:docs-build-warnings

Conversation

@melissawm
Copy link
Copy Markdown
Contributor

@melissawm melissawm commented Jul 4, 2025

Closes #9256

One remaining question is if the removed empty html comment block can be safely removed.

The errors fixed by this PR are:

  • Several WARNING: duplicate label
  • xla/docs/source/contribute/plugins.md:68: ERROR: Unknown directive type "=html".
  • xla/docs/source/learn/_pjrt.md: WARNING: document isn't included in any toctree
  • xla/docs/source/learn/_pjrt.md:38: WARNING: 'myst' reference target not found: #multithreading-on-tpu-v2v3
  • xla/docs/source/learn/_pjrt.md:400: WARNING: 'myst' reference target not found: ./ddp.md
  • xla/docs/source/learn/_pjrt.md:400: WARNING: 'myst' reference target not found: ../test/test_train_mp_imagenet.py
  • xla/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:

  • MyST autogenerates header labels, and I believe the autosectionlabel extension was clashing with the MyST default configuration. What changes is that MyST normalizes anchor labels so that # My Section Name has a corresponding anchor of #my-section-name.
  • For the spmd_advanced.md file, I'm not sure that this is the correct information organization, but it does match what is currently displayed on the live docs website.

@qihqi qihqi enabled auto-merge (squash) July 7, 2025 16:22
Comment thread docs/source/contribute/plugins.md Outdated
Comment thread docs/source/learn/pytorch-on-xla-devices.md
auto-merge was automatically disabled July 7, 2025 17:50

Head branch was pushed to by a user without write access

@melissawm
Copy link
Copy Markdown
Contributor Author

Thanks for the reviews - please let me know if I can address any other feedback. Cheers!

@qihqi
Copy link
Copy Markdown
Collaborator

qihqi commented Jul 11, 2025

@melissawm please rebase to head, we did some fix on the CI. thanks!

@melissawm melissawm force-pushed the docs-build-warnings branch from 1a01be9 to ed466c0 Compare July 11, 2025 14:06
@melissawm
Copy link
Copy Markdown
Contributor Author

Done!

@qihqi qihqi merged commit d7c9e50 into pytorch:master Jul 16, 2025
23 of 24 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Docs build issues errors / warnings on duplicate labels (anchors)

4 participants