Skip to content

Commit 99b1d40

Browse files
committed
feat: add pydoc-markdown configuration for documentation generation
Signed-off-by: James Ding <[email protected]>
1 parent 54bc101 commit 99b1d40

File tree

2 files changed

+752
-0
lines changed

2 files changed

+752
-0
lines changed

pyproject.toml

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -56,9 +56,27 @@ asyncio_mode = "auto"
5656
[dependency-groups]
5757
dev = [
5858
"mypy>=1.14.1",
59+
"pydoc-markdown>=4.8.2",
5960
"pytest>=8.3.5",
6061
"pytest-asyncio>=0.24.0",
6162
"pytest-cov>=5.0.0",
6263
"python-dotenv>=1.0.1",
6364
"ruff>=0.14.3",
6465
]
66+
67+
[[tool.pydoc-markdown.loaders]]
68+
type = "python"
69+
packages = ["fishaudio", "fish_audio_sdk"]
70+
71+
[tool.pydoc-markdown.renderer]
72+
type = "mkdocs"
73+
pages = [
74+
{title = "Fish Audio SDK", name="index", source = "README.md"},
75+
{title = "Client", name="fishaudio/client", contents = ["fishaudio.client.*"] },
76+
{title = "Resources", name="fishaudio/resources", contents = ["fishaudio.resources.*"] },
77+
{title = "Types", name="fishaudio/types", contents = ["fishaudio.types.*"] },
78+
{title = "Core", name="fishaudio/core", contents = ["fishaudio.core.*"] },
79+
{title = "Utils", name="fishaudio/utils", contents = ["fishaudio.utils.*"] },
80+
{title = "Exceptions", name="fishaudio/exceptions", contents = ["fishaudio.exceptions.*"] },
81+
{title = "Legacy SDK", name="fish_audio_sdk", contents = ["fish_audio_sdk.*"]},
82+
]

0 commit comments

Comments
 (0)