From 2ecea9515b0b8d7294d670917c3c82faba7954a7 Mon Sep 17 00:00:00 2001 From: Wiktor Kwapisiewicz Date: Wed, 13 Dec 2023 10:43:38 +0100 Subject: [PATCH] Set site description --- book/source/conf.py | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/book/source/conf.py b/book/source/conf.py index 8190e40..63de928 100644 --- a/book/source/conf.py +++ b/book/source/conf.py @@ -20,6 +20,7 @@ version = "0.1" suppress_warnings = [ 'epub.unknown_project_files', ] +description = 'The essential OpenPGP guide for application developers. Learn the OpenPGP standard for cryptographic operations and how to implement it in your projects. Gain insights into digital signatures, key management, certificates, and more. Version agnostic.' # -- General configuration --------------------------------------------------- # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration @@ -54,11 +55,19 @@ myst_enable_extensions = [ "deflist", ] +# https://myst-parser.readthedocs.io/en/latest/configuration.html#setting-html-metadata +myst_html_meta = { + "description lang=en": description, + "keywords": "openpgp, cryptographic operations, data encryption, digital signatures, key management, identity verification, secure communication, pgp, cryptographic protocols, public key encryption, openpgp v4, openpgp v6, openpgp implementation", + "property=og:locale": "en_US" +} + # -- Options for EPUB output ------------------------------------------------- # https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-epub-output epub_copyright = f'{date.today().year}, {author} ({upstream_url}), CC-BY-SA-4.0' epub_cover = ('_static/epub/img/cover.png', 'cover.j2') +epub_description = description epub_css_files = [ 'epub/css/custom.css' ] @@ -93,3 +102,9 @@ html_theme_options = { # https://github.com/wpilibsuite/sphinxext-opengraph#simple-config ogp_site_url = 'https://openpgp.dev/book/' ogp_image = '_static/html/img/logo.png' +ogp_type = 'book' + +ogp_custom_meta_tags = [ + f'', +] +