Skip to content

Commit 4fcc0f6

Browse files
committed
Fix numpy docstring option for pdoc
Add justfile
1 parent 3dc7231 commit 4fcc0f6

3 files changed

Lines changed: 13 additions & 5 deletions

File tree

‎.github/workflows/docs.yml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ jobs:
3131

3232
- run: uv sync --group dev
3333

34-
- run: uv run pdoc -o site zarr_sqlite
34+
- run: uv run pdoc -o site -d numpy zarr_sqlite
3535

3636
- uses: actions/upload-pages-artifact@v3
3737
with:

‎Justfile‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
test:
2+
uv run pytest
3+
4+
check:
5+
uv run ruff check
6+
uv run mypy src/
7+
8+
build-docs:
9+
uv run pdoc -o site -d numpy zarr_sqlite
10+
11+
doc:
12+
uv run pdoc -d numpy zarr_sqlite

‎pyproject.toml‎

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,3 @@ markers = [
4040
]
4141
python_files = ["test_*.py", "benchmark_*.py"]
4242
testpaths = ["test"]
43-
44-
[tool.pdoc]
45-
docformat = "numpy"
46-
exclude = ["zarr_sqlite._db_utils", "zarr_sqlite.async_sqlite", "zarr_sqlite._version", "zarr_sqlite.zarr_sqlite"]

0 commit comments

Comments
 (0)