Take default og:site_name from sphinx project config value
#83
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- The standard `project` Sphinx config value seems like a reasonable default value for the site_name. - This uses that as a default, if `ogp_site_name` is not set. - This will change the default, and add `og:site_name` for many projects where it previously wasn't set.
hugovk
reviewed
Nov 8, 2022
|
The reason I think this is useful is that I can add this extension to any site and it's closer to being functional even without any configuration. Would we want a way to tell it to disable the |
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
|
Yes, there should be a way to turn this off, similar to ogp_image_alt. Default if ogp_site_name is None:
use project
elif ogp_site_name == False:
omit og:site_name
else:
use config site_name |
|
Updated and works in my local test. |
TheTripleV
approved these changes
Nov 22, 2022
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
projectSphinx config value seems like a reasonabledefault value for the site_name.
ogp_site_nameis not set.og:site_namefor manyprojects where it previously wasn't set.
Perhaps I should have asked before doing this, since the last point
may be a blocker. But it was easier to do than think too much...