본문 바로가기
반응형

mkdocs2

GitHub Actions로 API 문서 자동 생성 및 배포하기 GitHub Actions로 API 문서 자동 생성 및 배포하기(Cursor AI + Docstring + pdoc/mkdocs 통합 파이프라인)AI 코딩 도구로 코드 생산성을 높였다면, 그다음은? 바로 문서 자동화입니다.이 글에서는 Cursor AI로 자동 생성한 docstring을 기반으로 API 문서를 만들고, GitHub Actions를 통해 자동 배포하는 전체 파이프라인을 소개합니다. 특히 GitHub Actions를 처음 접하는 개발자를 위해, 개념부터 실전 예시까지 친절하게 설명할게요.✅ 최종 워크플로우 요약1. Cursor로 docstring 생성 2. Git push → GitHub Actions 실행 3. 문서 자동 생성 (pdoc or mkdocs) 4. GitHub Pages로.. 2025. 4. 12.
Cursor AI + Docstring으로 만드는 자동 API 문서화 파이프라인 구축 가이드 Cursor AI + Docstring으로 만드는 자동 API 문서화 파이프라인 구축 가이드AI 코딩 시대, 코드는 잘 짜는 것만큼 잘 설명하는 것도 중요합니다. Cursor AI를 사용하면 GPT-4의 힘으로 코드 문서화를 쉽게 자동화할 수 있습니다. 이번 글에서는 Cursor AI로 자동 생성한 docstring을 활용해 정식 API 문서를 만드는 전체 파이프라인을 소개합니다.📌 이 글에서 배우는 것Docstring이 뭔지, 왜 중요한지Cursor AI로 docstring 자동 생성하는 방법pdoc, mkdocs를 활용해 문서화하는 전체 흐름문서를 GitHub Pages 등에 배포하는 방법🧠 Docstring이란?Docstring은 Python에서 함수, 클래스, 모듈 등에 작성하는 설명용 주석 .. 2025. 4. 12.
반응형