Sphinx Extension to enable OGP support
Project description
sphinxext-opengraph
Sphinx extension to generate OpenGraph metadata (https://ogp.me/)
Installation
python -m pip install sphinxext-opengraph
Usage
Just add sphinxext.opengraph
to your extensions list in your conf.py
extensions = [
"sphinxext.opengraph",
]
Options
These values are placed in the conf.py of your sphinx project.
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.
ogp_site_url
- This config option is very important, set it to the URL the site is being hosted on.
ogp_description_length
- Configure the amount of characters taken from a page. The default of 200 is probably good for most people. If something other than a number is used, it defaults back to 200.
ogp_site_name
- This is not required. Name of the site. This is displayed above the title.
ogp_image
- This is not required. Link to image to show.
ogp_image_alt
- This is not required. Alt text for image. Defaults to using
ogp_site_name
or the document's title as alt text, if available. Set toFalse
if you want to turn off alt text completely.
- This is not required. Alt text for image. Defaults to using
ogp_use_first_image
- This is not required. Set to True to use each page's first image, if available. If set to True but no image is found, Sphinx will use
ogp_image
instead.
- This is not required. Set to True to use each page's first image, if available. If set to True but no image is found, Sphinx will use
ogp_type
- This sets the ogp type attribute, for more information on the types available please take a look at https://ogp.me/#types. By default it is set to
website
, which should be fine for most use cases.
- This sets the ogp type attribute, for more information on the types available please take a look at https://ogp.me/#types. By default it is set to
ogp_custom_meta_tags
- This is not required. List of custom html snippets to insert.
Example Config
Simple Config
ogp_site_url = "http://example.org/"
ogp_image = "http://example.org/image.png"
Advanced Config
ogp_site_url = "http://example.org/"
ogp_image = "http://example.org/image.png"
ogp_description_length = 300
ogp_type = "article"
ogp_custom_meta_tags = [
'<meta property="og:ignore_canonical" content="true" />',
]
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Close
Hashes for sphinxext-opengraph-0.5.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 78675a8a490c749a881892abc4f28ac3a2e8e65b066fe346fa7da882290906a5 |
|
MD5 | f17abace33321ffee051a6a229be4b49 |
|
BLAKE2b-256 | 9d86d15957e0d2f3a4ab3ef0376365e1a9cff797dddcae71f3ceb35438f7c363 |
Close
Hashes for sphinxext_opengraph-0.5.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3fd0df576ae11e55c710653413edd7c05db65a4fbf985d536127c5ac06f5d2cb |
|
MD5 | e4d0b9aa7b19cc30f34fe3c678f4a504 |
|
BLAKE2b-256 | bd7dd3676c97f2846c5784ecf17411d8743bee2868fc4b7637a51db57d67644b |