diff --git a/pdm.lock b/pdm.lock index 1b9ffd88..7fba5ab3 100644 --- a/pdm.lock +++ b/pdm.lock @@ -5,7 +5,7 @@ groups = ["default"] strategy = ["cross_platform"] lock_version = "4.4" -content_hash = "sha256:4ae6465e4775ea65393645a2a7a64620713183e9dd022a4b382578faefdbf006" +content_hash = "sha256:c563471601aec321f5169e2ec740f96d1165e78f12f74071b3c875470dc92a2e" [[package]] name = "aiohttp" @@ -226,6 +226,16 @@ files = [ {file = "colorama-0.4.6.tar.gz", hash = "sha256:08695f5cb7ed6e0531a20572697297273c47b8cae5a63ffc6d6ed5c201be6e44"}, ] +[[package]] +name = "docstring-parser" +version = "0.15" +requires_python = ">=3.6,<4.0" +summary = "Parse Python docstrings in reST, Google and Numpydoc format" +files = [ + {file = "docstring_parser-0.15-py3-none-any.whl", hash = "sha256:d1679b86250d269d06a99670924d6bce45adc00b08069dae8c47d98e89b667a9"}, + {file = "docstring_parser-0.15.tar.gz", hash = "sha256:48ddc093e8b1865899956fcc03b03e66bb7240c310fac5af81814580c55bf682"}, +] + [[package]] name = "frozenlist" version = "1.4.0" @@ -503,6 +513,20 @@ files = [ {file = "pydantic_core-2.14.1.tar.gz", hash = "sha256:0d82a6ee815388a362885186e431fac84c7a06623bc136f508e9f88261d8cadb"}, ] +[[package]] +name = "sophia-doc" +version = "0.1.6" +requires_python = ">=3.8" +summary = "A python package to automatically generate API documents for Python modules." +dependencies = [ + "docstring-parser>=0.15", + "typing-extensions>=4.7.1", +] +files = [ + {file = "sophia_doc-0.1.6-py3-none-any.whl", hash = "sha256:a41bf8a1db975fba5c10bb6432f4622bda5577eae22afce09d67dac2367c7c6a"}, + {file = "sophia_doc-0.1.6.tar.gz", hash = "sha256:2e17362556c1ee1c35bf4e58b5dec20f1bcb8d5b46c275f25e34a053de7c02cc"}, +] + [[package]] name = "tomli" version = "2.0.1" diff --git a/pyproject.toml b/pyproject.toml index 8f8910bd..456081b2 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -33,6 +33,7 @@ dependencies = [ "aiohttp>=3.8.0,<4.0.0", "loguru>=0.7.0,<0.8.0", "typing-extensions>=4.5.0", + "sophia-doc>=0.1.6", ] [project.optional-dependencies]