Skip to content

Commit 8d17746

Browse files
committed
Fixes failing doc tests, adds doctest info to docs
1 parent d99e4af commit 8d17746

2 files changed

Lines changed: 12 additions & 1 deletion

File tree

docs/conftest.py

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@
2525
from dicomtrolley.qido_rs import QidoRS
2626
from dicomtrolley.rad69 import Rad69
2727
from dicomtrolley.trolley import Trolley
28-
from dicomtrolley.wado_rs import WadoRS
28+
from dicomtrolley.wado_rs import WadoRS, WadoRSMetaData
2929
from dicomtrolley.wado_uri import WadoURI
3030
from tests.conftest import set_mock_response
3131
from tests.factories import quick_dataset
@@ -73,6 +73,7 @@ def setup_namespace(namespace: Dict[str, Any]):
7373
"Mint": Mint,
7474
"WadoURI": WadoURI,
7575
"WadoRS": WadoRS,
76+
"WadoRSMetadata": WadoRSMetaData,
7677
"Rad69": Rad69,
7778
"QidoRS": QidoRS,
7879
"Query": Query,

docs/contributing.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -62,3 +62,13 @@ To edit the docs:
6262
* Try out your changes using `uv run mkdocs serve`
6363

6464
* To add docs requirements: `uv add --group dev <package to add>`. To remove `uv remove --group dev <package to add>`
65+
66+
### testing doc examples
67+
* run pytest in the /docs folder: `cd /docs` -> `uv run pytest`
68+
69+
If your docstests have import errors, look at /docs/conftest.py -> `setup_namespaces()`.
70+
This function describes import statements done before any doc example script. Imports
71+
are done in script because it is distracting to have multiple import statements above
72+
a single line of example code
73+
74+

0 commit comments

Comments
 (0)