Skip to content

Commit

Permalink
added collapsible sections to guides/contributing.rst
Browse files Browse the repository at this point in the history
  • Loading branch information
shvmm authored Oct 21, 2024
1 parent 4d329c6 commit ce55fee
Showing 1 changed file with 33 additions and 0 deletions.
33 changes: 33 additions & 0 deletions guides/contributing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -251,6 +251,39 @@ 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

Check failure on line 256 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:256
.. collapse:: Details

Check failure on line 257 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:257
Something small enough to escape casual notice.
.. collapse:: Open
:open:

Check failure on line 261 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:261
This section is open by default.
.. collapse:: A long code block

Check failure on line 264 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:264
.. code-block:: python

Check failure on line 265 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:265
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 280 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:280
print("Not really")
.. note::

A blank line is *required* after every ``collapse`` directive.

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

.. code-block:: rst
Expand Down

0 comments on commit ce55fee

Please sign in to comment.