Skip to content
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

Add OpenGraph metadata to docs via Sphinx extension #3205

Merged
merged 1 commit into from
Oct 18, 2023

Conversation

justinmayer
Copy link
Member

Uses the sphinxext-opengraph Sphinx extension to generate OpenGraph metadata for Pelican's documentation.

@pauloxnet
Copy link
Member

Uses the sphinxext-opengraph Sphinx extension to generate OpenGraph metadata for Pelican's documentation.

+1 for me

Do we need to add some variables in the config?
https://github.com/wpilibsuite/sphinxext-opengraph#example-config

@justinmayer
Copy link
Member Author

From the Options section of that same README:

Users hosting documentation on Read The Docs do not need to set any of the following unless custom configuration is wanted. The extension will automatically retrieve your site URL.

@pauloxnet
Copy link
Member

LGTM

Copy link
Member

@avaris avaris left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍🏻

@justinmayer
Copy link
Member Author

@pauloxnet / @avaris: Many thanks for taking a look at this and providing feedback 😁

@justinmayer justinmayer merged commit 36b4c6d into master Oct 18, 2023
22 checks passed
@justinmayer justinmayer deleted the sphinx-opengraph branch October 18, 2023 06:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants