Extension

The Linux Kernel Tea Leaves is now a Sphinx extension you can embed in your own documentation.

Installation

It’s in the repository. I’m afraid you’ll have to figure it out by yourself.

You’ll need to also copy the template from this project’s Sphinx template directory, or create your own.

Configuration

linux_kernel_tea_leaves_template: str

Name of the template within the Sphinx template directory. Defaults to tealeaves.rst.

linux_kernel_tea_leaves_releases: int

Number of kernel release cycles to predict. Defaults to 3.

Directive

.. tealeaves::

Directive to embed predictions in the current document.

:template: (text)

Name of the template within the Sphinx template directory. Defaults to linux_kernel_tea_leaves_template

:format: (text)

Template format, either rst or html. Defaults to rst if the name of the template ends in .rst or .rest, html otherwise.

:releases: (int)

Number of kernel release cycles to predict. Defaults to linux_kernel_tea_leaves_releases.

:tag: (text)

Tag to use for reference instead of fetching the latest tag from the upstream repository. Primarily for testing purposes.

:date: (text)

Date to use for the tag instead of fetching the tag date from the upstream repository. Primarily for testing purposes.