File: myst-doctest-use-rest.md

package info (click to toggle)
python-sybil 9.2.0-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 1,148 kB
  • sloc: python: 4,510; makefile: 90
file content (41 lines) | stat: -rw-r--r-- 519 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
# DocTest examples

A Python REPL / DocTest example using normal way of specifying Python
language:

```python
>>> x = 1+1
>>> x
2

```

A Python REPL / DocTest example using a MyST role:

```{code-block} python
>>> x += 1; x
3

```

A Python REPL / DocTest example using the `{eval-rst}` role and the `.. doctest::` role
from `sphinx.ext.doctest`:


```{eval-rst}
.. doctest::

    >>> 1 + 1
    3

```


```{doctest}
>>> y = 2
>>> raise Exception('uh oh')
Traceback (most recent call last):
...
Exception: uh oh

```