Skip to content

Commit ab67526

Browse files
authored
Update README.rst
1 parent 446e760 commit ab67526

File tree

1 file changed

+15
-12
lines changed

1 file changed

+15
-12
lines changed

README.rst

Lines changed: 15 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -11,24 +11,27 @@ Overview
1111
--------
1212

1313
This module renders docs like
14-
```
15-
.. method:: __add__(other)
16-
Docstring
17-
```
14+
15+
.. code-block:: rst
16+
17+
.. method:: __add__(other)
18+
Docstring
19+
20+
1821
as
19-
```
22+
2023
self + other
2124
Docstring
22-
```
25+
2326

2427
After installing this module, add the following to your `conf.py` to enable it
2528

26-
```
27-
extensions = [
28-
... # your other extensions
29-
'sphinxcontrib.prettyspecialmethods',
30-
]
31-
```
29+
.. code-block:: python
30+
31+
extensions = [
32+
... # your other extensions
33+
'sphinxcontrib.prettyspecialmethods',
34+
]
3235
3336
3437
Links

0 commit comments

Comments
 (0)