Skip to content

docs(fix): replace img tag with Markdown images #1087

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Apr 10, 2025

Conversation

mikemckiernan
Copy link
Member

@mikemckiernan mikemckiernan commented Apr 2, 2025

Description

The img HTML tags do not communicate to Sphinx to copy the graphic to the output HTML. As a result, all the images were missing.

Review HTML: https://nvidia.github.io/NeMo-Guardrails/review/pr-1087/user-guides/guardrails-process.html

Related Issue(s)

Checklist

  • I've read the CONTRIBUTING guidelines.
  • I've updated the documentation if applicable.
  • I've added tests if applicable.
  • @mentions of the person or team responsible for reviewing proposed changes.

Copy link

github-actions bot commented Apr 2, 2025

Documentation preview

https://nvidia.github.io/NeMo-Guardrails/review/pr-1087

@mikemckiernan mikemckiernan self-assigned this Apr 2, 2025
@mikemckiernan mikemckiernan added the documentation Improvements or additions to documentation label Apr 2, 2025
@mikemckiernan
Copy link
Member Author

@Pouyanpi , PTAL at the pyproject.toml and lock file updates. If the changes concern you, PLMK. TY, as always!

@Pouyanpi
Copy link
Collaborator

Pouyanpi commented Apr 2, 2025

@Pouyanpi , PTAL at the pyproject.toml and lock file updates. If the changes concern you, PLMK. TY, as always!
Thank you Mike! It seems you are using Poetry 2 locally

We have 2 options:

  1. use poetry < 2 like 1.8.2 and force push
  2. merge it once chore: update Poetry to version 2.1.2 across workflows #1078 is merged

I have also faced some issues with poetry version mismatch and my 2 latest PRs are failing.

@Pouyanpi
Copy link
Collaborator

Pouyanpi commented Apr 2, 2025

@Pouyanpi , PTAL at the pyproject.toml and lock file updates. If the changes concern you, PLMK. TY, as always!
Thank you Mike! It seems you are using Poetry 2 locally

We have 2 options:

  1. use poetry < 2 like 1.8.2 and force push
  2. merge it once chore: update Poetry to version 2.1.2 across workflows #1078 is merged

I have also faced some issues with poetry version mismatch and my 2 latest PRs are failing.

or even a third option if possible:

  1. create a separate PR with dependency changes, like chore(deps): constraint nvidia-sphinx-theme ...

@mikemckiernan mikemckiernan force-pushed the mmck-restore-graphic branch from c254686 to 21a3406 Compare April 2, 2025 17:21
@mikemckiernan
Copy link
Member Author

or even a third option if possible:

  1. create a separate PR with dependency changes, like chore(deps): constraint nvidia-sphinx-theme ...

I moved the deps update into #1090 using poetry 1.8.2. No objection from me, it was strained to do it in this PR.

@Pouyanpi
Copy link
Collaborator

Pouyanpi commented Apr 2, 2025

@mikemckiernan Is following OK? {W=75% align=center}

I mean does it only happen on Github?

image

@mikemckiernan mikemckiernan force-pushed the mmck-restore-graphic branch from 21a3406 to 5cbbefc Compare April 2, 2025 20:05
@mikemckiernan mikemckiernan force-pushed the mmck-restore-graphic branch from 5cbbefc to 71438e9 Compare April 2, 2025 20:06
@mikemckiernan
Copy link
Member Author

@mikemckiernan Is following OK? {W=75% align=center}

I mean does it only happen on Github?

Ugh. No. I misunderstood the MyST Parser syntax. I pushed an update that uses an image directive. TY!

@mikemckiernan mikemckiernan added this to the v0.14.0 milestone Apr 3, 2025
Copy link
Collaborator

@Pouyanpi Pouyanpi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank You Mike and apologies for getting back to it now 👍🏻

@Pouyanpi Pouyanpi merged commit 940d691 into NVIDIA:develop Apr 10, 2025
2 checks passed
@mikemckiernan mikemckiernan deleted the mmck-restore-graphic branch April 24, 2025 15:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants