Repository navigation
docs: Fix images not rendering in docs - #954
Merged
Merged
Conversation
Signed-off-by: James Bourbeau <jbourbeau@nvidia.com>
jrbourbeau
changed the title
thomasdhc
approved these changes
Dec 10, 2025
HuiyingLi
reviewed
Dec 10, 2025
| :class: bg-primary | ||
| :width: 600px | ||
| :align: center | ||
| ``` |
Contributor
There was a problem hiding this comment.
Would something the following work?
<img src="https://raw.githubusercontent.com/NVIDIA-NeMo/Automodel/refs/heads/main/docs/guides/fp8_convergence.jpg" alt="FP8 Convergence Comparison" width="600px" />
Member
Author
There was a problem hiding this comment.
I think using local files is probably better in this case (for example, there can be mismatches when doing development, versioning of docs, etc).
If you're looking for something that will render both in the docs and when viewed on GitHub, we would need to move away from myst markdown parsing. That's not always possible, but is in this case with something like this
diff --git a/docs/guides/omni/gemma3-3n.md b/docs/guides/omni/gemma3-3n.md
index ac11367..5443c93 100644
--- a/docs/guides/omni/gemma3-3n.md
+++ b/docs/guides/omni/gemma3-3n.md
@@ -218,12 +218,7 @@ peft:
The training loss should look similar to the example below:
-```{image} medpix_peft.jpg
-:alt: Training Loss Curve
-:class: bg-primary
-:width: 400px
-:align: center
-```
+{.bg-primary w=400px align=center}
### Checkpointing
linnanwang
pushed a commit
that referenced
this pull request
Apr 24, 2026
Signed-off-by: James Bourbeau <jbourbeau@nvidia.com>
kashif
pushed a commit
to kashif/Automodel
that referenced
this pull request
May 25, 2026
Signed-off-by: James Bourbeau <jbourbeau@nvidia.com>
This branch was previously deployed
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
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.
This PR fixes a few images I noticed we're rendering in the docs.
Before this PR:
After this PR: