DOC: Moved VQ example & target from duplicate array broadcasting doc #19369
Conversation
There was a problem hiding this comment.
Thanks @Mukulikaa - I agree with doing this in pieces so I'm ok with it for now. I wonder though if it would just be easier to remove the part you already included in the main broadcasting document from the orphan page, so we don't redo the work later.
|
|
||
| .. figure:: theory.broadcast_5.png | ||
| :alt: vector quantitization example | ||
| :name: figure-1 |
There was a problem hiding this comment.
This is the reason for the CI failure: this image name is referenced twice (here and in the other document). Can you change this "name" argument to something different?
There was a problem hiding this comment.
Thanks! I was aware of that but decided to ignore it for now because eventually the other doc would be removed and it wouldn't clash anymore. But now that I think of it, I should use a different naming system e.g. "doc-name.figure no." so that it doesn't cause a problem later on when we include figures in other documents too.
There was a problem hiding this comment.
I wonder though if it would just be easier to remove the part you already included in the main broadcasting document from the orphan page, so we don't redo the work later.
+1 this would make it easier to keep track of what content has already been moved, especially if the full transfer will occur over multiple PRs.
|
Last (maybe nit?) suggestion: since we have moved content from this page to the |
|
I think it does make sense to do that for users who might land on the page through external sources. Does this mean we can never remove the |
|
I think the test failure is unrelated. |
1. Deleted older formats of the graphics which belonged to the orphan doc 2. Added SVGs for the same diagrams (with necessary corrections) 3. Added detailed alt-texts for each diagram and graph 4. Removed all content from the orphan doc since all of it has been moved
|
Hi @MarsBarLee, I have converted all the diagrams in the doc to the SVG format and added alt-texts for them. It would be nice if you could review the doc once when you have time! |
|
Hi Mukulika, the alt-text and SVGs look good! Thank you for including those changes. |
Co-authored-by: Melissa Weber Mendonça <[email protected]>
|
@rossbar want to take a last look? |
|
Thanks @Mukulikaa |
Closes #19136
According to the plan discussed in the issue, I have added the vector quantization example to the main
Broadcastingdoc. I have tried to add some explanations to it from the EricsBroadcastingDoc (the original source of both the broadcasting docs).In an attempt to accommodate references to the orphan doc, I have moved the sphinx cross-linking target to the main Broadcasting doc. I tested it locally and it works, but I'm not sure if it's best practice to do that.
I wanted some feedback on the crosslinking hack and whether the example reads like a tutorial. Thanks!
cc: @melissawm @rossbar