Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Should we configure more defaults for opengraph? #4

Open
consideRatio opened this issue Jan 10, 2023 · 4 comments
Open

Should we configure more defaults for opengraph? #4

consideRatio opened this issue Jan 10, 2023 · 4 comments

Comments

@consideRatio
Copy link
Member

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
Copy link
Member

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

WDYT?

@consideRatio
Copy link
Member Author

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
Copy link
Member

manics commented Mar 3, 2023

It was released last month https://github.com/wpilibsuite/sphinxext-opengraph/releases
The required release is not set in this repo:

"sphinxext-opengraph"

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
Copy link
Member Author

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.

# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants