docs: ignore anchor for observability links #9412
Conversation
|
Docsite preview being generated for this PR. |
|
Docsite preview being generated for this PR. |
✅ Deploy Preview for determined-ui canceled.
|
| "metrics", | ||
| "join-metrics", | ||
| "exposed-metrics", | ||
| "L139-L169", |
There was a problem hiding this comment.
it seems like sphinx finds github anchors problematic in general, let's just ignore a glob/regex for all github anchors? these individual line links are going to be especially hard to catch if we slightly change the link url.
there's linkcheck_anchors_ignore_for_url, https://www.sphinx-doc.org/en/master/usage/configuration.html#confval-linkcheck_anchors_ignore_for_url which seems a good fit for our use case?
There was a problem hiding this comment.
This is a good idea, but I don't know that it's the right fit here.
linkcheck_anchors_ignore_for_url requires sphinx version 7.1+, but docs /requirements.txt pins sphinx to sphinx==4.2.0
I also think the brittleness of specifying specific anchors is a good thing in this case. Not all github links will necessarily be valid; shouldn't we check them one by one and manually "ok" them?
There was a problem hiding this comment.
i see. then what you had before is fine.
|
Docsite preview being generated for this PR. |
|
Docsite preview being generated for this PR. |
1 similar comment
|
Docsite preview being generated for this PR. |
Ticket
RM-313
Description
Observability docs include 4 links that are valid, but are failing
check-links. Add anchors to ignore list to reduce noise and ci failures.Test Plan
None needed.
Checklist
docs/release-notes/.See Release Note for details.