From 524f069a086f41b1b01142f67ec834a9f563f5fe Mon Sep 17 00:00:00 2001 From: Steve Manuel Date: Fri, 17 Mar 2023 13:00:47 -0600 Subject: [PATCH] feat: add pycco python doc support (#284) --- .gitignore | 1 + python/Makefile | 4 ++-- python/pyproject.toml | 2 +- 3 files changed, 4 insertions(+), 3 deletions(-) diff --git a/.gitignore b/.gitignore index 5ca01c7..7013599 100644 --- a/.gitignore +++ b/.gitignore @@ -30,6 +30,7 @@ rust/test.log duniverse _build php/Extism.php +python/docs dist-newstyle .stack-work vendor diff --git a/python/Makefile b/python/Makefile index 4779547..6c060cf 100644 --- a/python/Makefile +++ b/python/Makefile @@ -20,7 +20,7 @@ lint: poetry run black --check extism/ tests/ example.py docs: - poetry run pdoc --force --html extism + poetry run pycco extism/*.py show-docs: docs - open html/extism/index.html + open docs/extism.html diff --git a/python/pyproject.toml b/python/pyproject.toml index ee94645..cbd4c93 100644 --- a/python/pyproject.toml +++ b/python/pyproject.toml @@ -12,7 +12,7 @@ cffi = "^1.10.0" [tool.poetry.dev-dependencies] black = "^23.1.0" -pdoc3 = "^0.10.0" +pycco = "^0.6.0" [build-system] requires = ["poetry-core>=1.0.0"]