-
Notifications
You must be signed in to change notification settings - Fork 140
docs: add opengraph metadata tags #860
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: master
Are you sure you want to change the base?
Conversation
…upstream feature There's an upstream PR for this feature, but it has stalled for a while now. I completely understand if the maintainers do not want to add such a feature, however it's still useful in our particular case, so let's go with the slightly more convoluted way for now.
Since the upstream PR this is waiting on has been stalled for a while now, I've decided to go with the slightly more If (and that's a big if, I'd understand if the maintainers don't want to add this feature) the other PR gets merged at some point, we can always update to that. |
blocked by #722 |
would you please rebase on master and resolve conflicts? |
8166b87
to
bb12cd6
Compare
I've changed it to generate more concise descriptions, by only taking the first section into account. The |
Perhaps we can launch it on all pages, and remove it from API reference pages if it turns out to not work too well. (We won't know unless we try it) |
Sound good to me, then. |
Summary
Adds sphinxext-opengraph to generate Open Graph metadata on all docs pages.
As an example, the resulting Discord embed looks like this:

Depends on sphinx-doc/sphinxext-opengraph#86 for now, but we're in no rush to add this anyway.Checklist
task lint
task pyright