Skip to content

Commit ea71375

Browse files
funkyfutureChilipp
andauthored
docs: Adds missing directives
Co-authored-by: Philipp S. Sommer <[email protected]>
1 parent b1e8947 commit ea71375

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

docs/conf_settings.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -146,12 +146,16 @@ Configuration values and events
146146
The default value is ``None``.
147147
Example usage with a tuple that defines an arbitrary order:
148148

149+
.. code-block:: python
150+
149151
sections_order = ("Public methods", "Attributes", "Private methods")
150152
autodocsumm_section_sorter = lambda title: sections_order.index(title)
151153
152154
An example for cases that only ensures that "Constructors" are always listed
153155
first and "Attributes" while not failing when encountering undefined section
154156
weights:
155157

158+
.. code-block:: python
159+
156160
section_weights = {"Attributes": 100, "Constructors": -100}
157161
autodocsumm_section_sorter = lambda title: sections_weights.get(title, 0)

0 commit comments

Comments
 (0)