Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add collapse and tab examples to guides/contributing.rst #4359

Merged
merged 12 commits into from
Oct 21, 2024
159 changes: 159 additions & 0 deletions guides/contributing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -251,6 +251,165 @@ adhere to the following order:

Note that a blank line is *required* after every ``code-block`` directive.

- **Collapsible section**: To add a collapsible section, use the ``collapse`` directive:

.. code-block:: rst

.. collapse:: Details

Something small enough to escape casual notice.

.. collapse:: Details

Something small enough to escape casual notice.

.. code-block:: rst

.. collapse:: A long code block

.. code-block:: yaml

# Sample configuration entry
switch:
- platform: gpio
name: "Relay #42"
pin: GPIOXX

.. collapse:: A long code block

.. code-block:: yaml

# Sample configuration entry
switch:
- platform: gpio
name: "Relay #42"
pin: GPIOXX

The ``:open:`` flag can be used to have the section open by default.

.. code-block:: rst

.. collapse:: Open
:open:

This section is open by default.

.. collapse:: Open
:open:

This section is open by default.

.. note::

- The ``:open:`` flag must immediately follow the ``collapse`` directive without a blank line between them.
- A blank line is *required* after every ``collapse`` directive.

- **Tabs**: To group content into tabs, use the ``tabs`` directive. The tabs directive defines a tab set.
Basic tabs are added using the ``tab`` directive (without s), which takes the tab’s label as an argument:

.. code-block:: rst

.. tabs::

.. tab:: Apples

Apples are green, or sometimes red.

.. tab:: Pears

Pears are green.

.. tab:: Oranges

Oranges are orange.

This will appear as

.. tabs::

.. tab:: Apples

Apples are green, or sometimes red.

.. tab:: Pears

Pears are green.

.. tab:: Oranges

Oranges are orange.

Tabs can also be nested inside one another:

.. code-block:: rst

.. tabs::

.. tab:: Stars

.. tabs::

.. tab:: The Sun

The closest star to us.

.. tab:: Proxima Centauri

The second closest star to us.

.. tab:: Polaris

The North Star.

.. tab:: Moons

.. tabs::

.. tab:: The Moon

Orbits the Earth

.. tab:: Titan

Orbits Jupiter

.. tabs::

.. tab:: Stars

.. tabs::

.. tab:: The Sun

The closest star to us.

.. tab:: Proxima Centauri

The second closest star to us.

.. tab:: Polaris

The North Star.

.. tab:: Moons

.. tabs::

.. tab:: The Moon

Orbits the Earth

.. tab:: Titan

Orbits Jupiter

.. note::

- A blank line is *required* after every ``tabs`` directive.
- The contents of each tab can be displayed by clicking on the tab that you wish to show.
Clicking again on the tab that is currently open will hide its content, leaving only the tab set labels visible.
- For advanced features like tab-groupings, refer to https://sphinx-tabs.readthedocs.io/en/latest/

- **Images**: Use the ``figure`` directive to display an image:

.. code-block:: rst
Expand Down