Opengraph improvements

[anupam-tiwari]

Describe your changes

Tasks

• investigate how to modify the Python documentation so it shows JupySQL documentation
• investigate how to display an image (most likely, we need to modify the html_meta)
• check if it's possible to display one image by default (so we are not missing anything, we can later customize them)
• create a sample image, you can use this template - note that this requires the draw.io app
• add it to a sample article, let's start with duckdb's one

Issue number

Closes #253

Checklist before requesting a review

• Performed a self-review of my code
• Formatted my code with pkgmt format
• Added tests (when necessary).
• Added docstring documentation and update the changelog (when needed)

---

📚 Documentation preview 📚: https://jupysql--685.org.readthedocs.build/en/685/

[anupam-tiwari]

@edublancas can you please check if this is the req!

[edublancas]

yep, this looks right!

the only missing item is:

• check if it's possible to display one image by default (in case a given article doesn't have one)

[edublancas]

example:

given your changes, duckdb's section shows a preview image: https://www.opengraph.xyz/url/https%3A%2F%2Fjupysql--685.org.readthedocs.build%2Fen%2F685%2Fintegrations%2Fduckdb.html

but all other sections don't show anything: https://www.opengraph.xyz/url/https%3A%2F%2Fjupysql--685.org.readthedocs.build%2Fen%2F685%2Fintro.html

so we want to show a default image so something always shows up while we add custom ones per section

[neelasha23]

1. Is there a way to test this before merging? (Point 1 can is verifiable but about the image? )
2. Are we handling this : check if it's possible to display one image by default (so we are not missing anything, we can later customize them) : in a separate issue? Then this PR is not completely closing Issue opengraph improvements #253

[anupam-tiwari]

@edublancas I tried checking if image can be a static image but I couldn't find a way out, I think image link is the only way, please let me know if there is some other way!

[edublancas]

@anupam-tiwari check merge conflicts

[edublancas]

remember to explicitly request a review when this is ready

[anupam-tiwari]

remember to explicitly request a review when this is ready

yes! this is not yet ready

[anupam-tiwari]

add a new section to the developer guide

Added!

[edublancas]

hey @anupam-tiwari: I'm going to close this now, no need to keep working on it