jupyterhub / jupyterhub-sphinx-theme

A lightweight wrapper theme for Sphinx based on the PyData Sphinx Theme
https://jupyterhub-sphinx-theme.readthedocs.io/en/latest/
BSD 3-Clause "New" or "Revised" License
0 stars 2 forks source link

Should we configure more defaults for opengraph? #4

Open consideRatio opened 1 year ago

consideRatio commented 1 year ago

This is the typical boilerplate opengraph config for jupyterhub projects when I activate opengraph now. Should we perhaps provide a default value for ogp_image and ogp_use_first_image?

# -- Options for the opengraph extension -------------------------------------
# ref: https://github.com/wpilibsuite/sphinxext-opengraph#options
#
# ogp_site_url is set automatically by jupyterhub-sphinx-theme
ogp_image = "_static/logo.png"
ogp_use_first_image = True
choldgraf commented 1 year ago

my hope is actually that we can get this merged and just use auto-generated images:

WDYT?

consideRatio commented 1 year ago

Aha, so with that, the fields ogp_image and ogp_use_first_image are no longer relevant? Then yeah sure let's wait and work towards that instead!

manics commented 1 year ago

It was released last month https://github.com/wpilibsuite/sphinxext-opengraph/releases The required release is not set in this repo: https://github.com/jupyterhub/jupyterhub-sphinx-theme/blob/d4071da94ccb40216389c413c04a0bd684dc764d/pyproject.toml#L20 Should it be up to the consuming repo to decide whether to set version constraints on the Sphinx plugins, or should that be handled by this theme?

consideRatio commented 1 year ago

Should it be up to the consuming repo to decide whether to set version constraints on the Sphinx plugins, or should that be handled by this theme?

I figure if this theme depends on logic introduced in a dependency of a certain version, we should put a lower version requirement (>=) on that dependency. But, if its unrelated to this themes own behavior and logic, where it would work fine, I think its out of scope to consider.