restructuredtext - How to control image previews for links to readthedocs/ sphinx page?

Question

posted Oct 7, 2021 in Technique[技术] by 深蓝 (71.8m points)

Is there a setting I can tweak in conf.py to ensure that image previews are generated for links to my index.html?

I think I need to put a link to the image inside:

<head><meta name="og:image" content="https://.png" /></head>

Maybe a setting on one of the html_* options? I read through them, but did not see anything.

https://www.sphinx-doc.org/en/master/usage/configuration.html

与恶龙缠斗过久,自身亦成为恶龙；凝视深渊过久,深渊将回以凝视…

1 Reply

深蓝 · Answer 1 · 2021-10-06T18:55:51+0000

One of many meta tags available in:

https://github.com/wpilibsuite/sphinxext-opengraph

conf.py

extensions = ['sphinxext.opengraph']

ogp_image = "https://raw.githubusercontent.com/aiqc/aiqc/main/docs/images/aiqc_logo_banner_controlroom.png"

It even has a field for user-defined <meta> tags.