Skip to content

Commit

Permalink
update metadata
Browse files Browse the repository at this point in the history
  • Loading branch information
jackaraz committed Jan 19, 2024
1 parent 38ecf04 commit 3b3ae00
Show file tree
Hide file tree
Showing 6 changed files with 10 additions and 0 deletions.
1 change: 1 addition & 0 deletions docs/api.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ 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
:property=og:url: https://spey.readthedocs.io/en/main/api.html

Top-Level
---------
Expand Down
2 changes: 2 additions & 0 deletions docs/comb.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,9 @@ Combining Statistical Models

.. meta::
:property=og:title: Combining Statistical Models
:property=og:description: Any likelihood definition under Spey can be combined.
:property=og:image: https://spey.readthedocs.io/en/main/_static/spey-logo.png
:property=og:url: https://spey.readthedocs.io/en/main/comb.html

In this section, we will provide a simple statistical model combination example using
`Path Finder algorithm <https://github.com/J-Yellen/PathFinder>`_
Expand Down
1 change: 1 addition & 0 deletions docs/exclusion.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ Exclusion limits
.. meta::
:property=og:title: Exclusion limits
:property=og:image: https://spey.readthedocs.io/en/main/_static/spey-logo.png
:property=og:url: https://spey.readthedocs.io/en/main/exclusion.html

Any Spey statistical model can compute the exclusion confidence level
using three options. Depending on the available functions in likelihood construction
Expand Down
2 changes: 2 additions & 0 deletions docs/new_plugin.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,9 @@ Building a plugin

.. meta::
:property=og:title: Building a plugin
:property=og:description: A Spey plug-in allows the usage of custom likelihood prescriptions for inference.
:property=og:image: https://spey.readthedocs.io/en/main/_static/spey-logo.png
:property=og:url: https://spey.readthedocs.io/en/main/new_plugin.html

``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.
Expand Down
2 changes: 2 additions & 0 deletions docs/plugins.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,9 @@ Plug-ins

.. meta::
:property=og:title: Plug-ins
:property=og:description: Currently supported likelihood prescriptions.
:property=og:image: https://spey.readthedocs.io/en/main/_static/spey-logo.png
:property=og:url: https://spey.readthedocs.io/en/main/plugins.html

Spey seamlessly integrates with diverse packages that offer specific
statistical model prescriptions. Its primary objective is to centralise
Expand Down
2 changes: 2 additions & 0 deletions docs/quick_start.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,9 @@ Quick Start

.. meta::
:property=og:title: Quick Start
:property=og:description: A beginner's guide.
:property=og:image: https://spey.readthedocs.io/en/main/_static/spey-logo.png
:property=og:url: https://spey.readthedocs.io/en/main/quick_start.html

Installation
------------
Expand Down

0 comments on commit 3b3ae00

Please sign in to comment.