search

stan-dev / cmdstanpy

CmdStanPy is a lightweight interface to Stan for Python users which provides the necessary objects and functions to compile a Stan program and fit the model to data using CmdStan.
BSD 3-Clause "New" or "Revised" License
149 stars 67 forks source link

CmdStanPy docs - add OpenGraph tags? #746

Closed mitzimorris closed 2 months ago

mitzimorris commented 2 months ago

Summary:

Discourse won't show preview of CmdStanPy docs because of lack of OpenGraph tags. When linking to CmdStanPy docs in Discourse post, the UI shows this warning

discourse_wtf

The fix would be to use OpenGraph, but is this worth it? Links without preview work just fine.

Description:

from Discourse: https://meta.discourse.org/t/unable-to-generate-a-preview-for-this-web-page-because-the-following-oembed-opengraph-tags-could-not-be-found-description-image/276711

from SO: https://stackoverflow.com/questions/70947883/how-to-set-opengraph-metadata-tags-for-a-sphinx-document

WardBrian commented 2 months ago

The second link you posted seems to imply we could use sphinxext-opengraph in our doc's conf.py with some minimal config.

I've not previously had any issues on the forums however. I think this just means it doesn't create a full-width banner style preview, but those are also often annoying when you're just trying to make a link

mitzimorris commented 2 months ago

I think this just means it doesn't create a full-width banner style preview, but those are also often annoying when you're just trying to make a link

agreed - the so-called "preview" feature is annoying and usually useless as well.

closing this as won't fix - the cost of adding more config and sphinx dependencies isn't worth it.