kwork-api/scripts/gen_docs.py
root 8d0e504aea docs: переключение на pydoc-markdown для генерации API документации
- Добавлен pydoc-markdown.yml для конфигурации генерации
- Обновлён mkdocs.yml (убран mkdocstrings, упрощена конфигурация)
- Добавлен скрипт scripts/gen_docs.py для автоматической генерации
- Обновлены зависимости в pyproject.toml (dependency-groups вместо dev-dependencies)
- Сгенерирована новая документация в docs/api_reference.md
2026-03-23 04:17:50 +00:00

44 lines
1.0 KiB
Python

#!/usr/bin/env python3
"""Generate API documentation using pydoc-markdown."""
import subprocess
import sys
from pathlib import Path
def main():
"""Generate documentation and build MkDocs site."""
project_root = Path(__file__).parent.parent
print("📝 Generating API documentation...")
result = subprocess.run(
["pydoc-markdown"],
cwd=project_root,
capture_output=False,
)
if result.returncode != 0:
print("❌ Failed to generate documentation")
return 1
print("✅ Documentation generated: docs/api_reference.md")
print("🏗️ Building MkDocs site...")
result = subprocess.run(
["mkdocs", "build", "--quiet"],
cwd=project_root,
capture_output=False,
)
if result.returncode != 0:
print("❌ Failed to build MkDocs site")
return 1
print("✅ Site built: site/")
print("\n✨ Done! Run 'mkdocs serve' to preview locally.")
return 0
if __name__ == "__main__":
sys.exit(main())