Skip to content

Commit 8b8f417

Browse files
authored
docs: fix Pydantic autodoc imports (#43)
1 parent 3c0ec37 commit 8b8f417

3 files changed

Lines changed: 4 additions & 2 deletions

File tree

.github/workflows/docs.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ jobs:
3535
uv sync --group docs
3636
3737
- name: Build documentation
38-
run: uv run sphinx-multiversion docs/source docs/build/html --keep-going --no-color
38+
run: uv run sphinx-multiversion docs/source docs/build/html --keep-going -W --no-color
3939

4040
- name: Generate index.html.
4141
run: |

CHANGELOG.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22

33
## v0.1.0-dev
44

5+
- Fix Sphinx autodoc imports for Pydantic-backed submission types.
56
- Add complete static typing across the SDK and tests, with typed single and batch
67
submission return values.
78
- Parse Judge0 UTC timestamps as timezone-aware values and validate submission

docs/source/conf.py

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -100,7 +100,8 @@
100100
"special-members": False,
101101
"inherited-members": False,
102102
}
103-
autodoc_mock_imports = ["httpx", "pydantic"]
103+
autodoc_mock_imports = ["httpx"]
104+
autodoc_type_aliases = {"Client": "judge0.clients.Client"}
104105

105106
napoleon_google_docstring = False
106107

0 commit comments

Comments
 (0)