1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
|
===================
sphinxext-opengraph
===================
.. image:: https://img.shields.io/pypi/v/sphinxext-opengraph.svg
:target: https://pypi.org/project/sphinxext-opengraph/
:alt: Package on PyPI
.. image:: https://github.com/sphinx-doc/sphinxext-opengraph/actions/workflows/test.yml/badge.svg
:target: https://github.com/sphinx-doc/sphinxext-opengraph/actions
:alt: Build Status
.. image:: https://img.shields.io/badge/License-BSD%203--Clause-blue.svg
:target: https://opensource.org/licenses/BSD-3-Clause
:alt: BSD 3 Clause
Sphinx extension to generate `Open Graph metadata`_
for each page of your documentation.
Installation
============
.. code-block:: sh
python -m pip install sphinxext-opengraph[social-cards]
# or
uv pip install sphinxext-opengraph[social-cards]
Usage
=====
See the `documentation`_.
.. _Open Graph metadata: https://ogp.me/
.. _documentation: https://sphinxext-opengraph.readthedocs.io/
|
