add metadata

SpeysideHEP · Jan 19, 2024 · 38ecf04 · 38ecf04
1 parent 3b26560
commit 38ecf04
Show file tree

Hide file tree

Showing 7 changed files with 30 additions and 0 deletions.
diff --git a/docs/api.rst b/docs/api.rst
@@ -1,6 +1,10 @@
 Description of all functions and classes
 ========================================
 
+.. meta::
+    :property=og:title: Description of all functions and classes
+    :property=og:image: https://spey.readthedocs.io/en/main/_static/spey-logo.png
+
 Top-Level
 ---------
 

diff --git a/docs/comb.rst b/docs/comb.rst
@@ -1,6 +1,10 @@
 Combining Statistical Models
 ============================
 
+.. meta::
+    :property=og:title: Combining Statistical Models
+    :property=og:image: https://spey.readthedocs.io/en/main/_static/spey-logo.png
+
 In this section, we will provide a simple statistical model combination example using 
 `Path Finder algorithm <https://github.com/J-Yellen/PathFinder>`_ 
 (For details, see :cite:`Araz:2022vtr`).

diff --git a/docs/exclusion.rst b/docs/exclusion.rst
@@ -1,6 +1,10 @@
 Exclusion limits
 ================
 
+.. meta::
+    :property=og:title: Exclusion limits
+    :property=og:image: https://spey.readthedocs.io/en/main/_static/spey-logo.png
+
 Any Spey statistical model can compute the exclusion confidence level
 using three options. Depending on the available functions in likelihood construction 
 (see :ref:`this section <sec_new_plugin>` for details), one or more of these options will be 

diff --git a/docs/index.rst b/docs/index.rst
@@ -6,6 +6,12 @@
 Welcome to the documentation of Spey
 ====================================
 
+.. meta::
+    :property=og:title: Spey
+    :property=og:description: smooth inference for reinterpretation studies
+    :property=og:image: https://spey.readthedocs.io/en/main/_static/spey-logo.png
+    :property=og:url: https://spey.readthedocs.io/en/main/
+
 .. image:: https://img.shields.io/github/issues/SpeysideHEP/spey?style=plastic&logo=github
    :alt: GitHub issues
    :target: https://github.com/SpeysideHEP/spey/issues

diff --git a/docs/new_plugin.rst b/docs/new_plugin.rst
@@ -3,6 +3,10 @@
 Building a plugin
 =================
 
+.. meta::
+    :property=og:title: Building a plugin
+    :property=og:image: https://spey.readthedocs.io/en/main/_static/spey-logo.png
+
 ``spey`` package has been designed to be expandable. It only needs to know certain aspects of the 
 data structure that is presented and a prescription to form a likelihood function.
 

diff --git a/docs/plugins.rst b/docs/plugins.rst
@@ -3,6 +3,10 @@
 Plug-ins
 ========
 
+.. meta::
+    :property=og:title: Plug-ins
+    :property=og:image: https://spey.readthedocs.io/en/main/_static/spey-logo.png
+
 Spey seamlessly integrates with diverse packages that offer specific 
 statistical model prescriptions. Its primary objective is to centralise
 these prescriptions within a unified interface, facilitating the 

diff --git a/docs/quick_start.rst b/docs/quick_start.rst
@@ -3,6 +3,10 @@
 Quick Start
 ===========
 
+.. meta::
+    :property=og:title: Quick Start
+    :property=og:image: https://spey.readthedocs.io/en/main/_static/spey-logo.png
+
 Installation
 ------------