atsphinx-og-article#

Overview#

This is Sphinx extension to handle properties of article typeof Open Graph.

You can add og-article directive with some options. This appends extra properties into meta tags from og-article directive.

This renders only article:** meta tags. For full functional as OpenGraph, install sphinxext-opengraph too.

This is registered on PyPI. You can install pip command.

pip install atsphinx-og-article

Edit your conf.py to add extension.

extensions = [
    "atsphinx.og_article",
]

Standard usage is adding og-article directive into your document. You may add directive into document that you want to consider as “article”.

.. og-article::
   :published_time: 2023-05-07

When you run html-like builders, generated files include <meta property="article:PROP" > elements from documents added directive.

.. og-article::#

published_time and modified_time accept any format that dateutil can parse. When it is parsing attribute, datetime object has timezone always.

These are complement by mutually. If one is not set, use another value automately. If neither not set, these are set build datetime.

:tags: (string)#: Comma separated list for tags of article. When this is set, extension generates article:tag properties per values separated comma.

og_article_timezone#

If this is not None, replace timezone of published_time and modified_time that do not have timezone text.