Skip to content
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

Fix html image rendering in sphinx documentation #7084

Merged
merged 3 commits into from
Apr 8, 2024
Merged

Conversation

tanmayv25
Copy link
Contributor

@tanmayv25 tanmayv25 commented Apr 8, 2024

MyST can be used to support the html image links in the documentation.

Please read about the extension here: https://myst-parser.readthedocs.io/en/latest/syntax/images_and_figures.html

With this change the html images are rendered properly in the docs.

Before

broken_image

After

fixed_images_sphinx

@tanmayv25 tanmayv25 requested review from indrajit96 and yinggeh April 8, 2024 22:35
indrajit96
indrajit96 previously approved these changes Apr 8, 2024
@tanmayv25 tanmayv25 requested a review from indrajit96 April 8, 2024 22:55
@tanmayv25 tanmayv25 merged commit c609d6c into main Apr 8, 2024
3 checks passed
@tanmayv25 tanmayv25 deleted the tanmayv-html-img branch April 8, 2024 23:11
Copy link
Contributor

Choose a reason for hiding this comment

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

Can you also update conf.py copyright to 2024? Thanks.

Copy link
Contributor

Choose a reason for hiding this comment

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

Can you also do the followings? I commited a change on your branch but looks like you just pushed with -f. Thanks.

  1. remove comments in line 330-332
  2. remove "1. " in line 326
  3. fix indentations

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

3 participants