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
34 changes: 34 additions & 0 deletions guides/contributing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -251,6 +251,40 @@

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

Check failure on line 258 in guides/contributing.rst

View workflow job for this annotation

GitHub Actions / build

Directive 'collapse' is not followed by an empty line. Please insert an empty line after guides/contributing.rst:258
Something small enough to escape casual notice.

.. collapse:: Open
:open:

Check failure on line 262 in guides/contributing.rst

View workflow job for this annotation

GitHub Actions / build

Directive 'collapse' is not followed by an empty line. Please insert an empty line after guides/contributing.rst:262
This section is open by default.

.. collapse:: A long code block

Check failure on line 265 in guides/contributing.rst

View workflow job for this annotation

GitHub Actions / build

Directive 'collapse' is not followed by an empty line. Please insert an empty line after guides/contributing.rst:265
.. code-block:: python

Check failure on line 266 in guides/contributing.rst

View workflow job for this annotation

GitHub Actions / build

Directive 'code-block' is not followed by an empty line. Please insert an empty line after guides/contributing.rst:266
print("Not really")

.. collapse:: Details

Something small enough to escape casual notice.

.. collapse:: Open

:open:

This section is expected to be open by default.

.. collapse:: A long code block

.. code-block:: python

Check failure on line 281 in guides/contributing.rst

View workflow job for this annotation

GitHub Actions / build

Directive 'code-block' is not followed by an empty line. Please insert an empty line after guides/contributing.rst:281
print("Not really")

.. note::

A blank line is *required* after every ``collapse`` directive.
shvmm marked this conversation as resolved.
Show resolved Hide resolved

shvmm marked this conversation as resolved.
Show resolved Hide resolved
- **Images**: Use the ``figure`` directive to display an image:

.. code-block:: rst
Expand Down
Loading