Panel box¶

A custom directive to creates boxes on subordinate index.rst files.

Warning

Do not use the panel-box on the root index.rst.

Syntax¶

.. panel-box::
   <options>

   <text>

Options¶

The topic-box directive supports the following options:

Option	Type	Required	Example Value	Description
title	string		Lorem ipsum	Hero box title.
class	string			Custom CSS class.

Usage¶

For example, using:

.. panel-box::
   :title: Admin

   Test

Results in:

Admin

Test