Welcome to Sphinx Documentation!

최종 수정일: Jan 05, 2023

Python 기반의 문서화 도구인 Sphinx 사용법에 대한 문서입니다. Sphinx 지금 보시는 것과 같은 문서를 작성할 수 있게 합니다. 이 문서는 순서대로 읽도록 작성되어있습니다.

Contents

• Sphinx 설치
  • 파이썬 설정
  • VSCode 설정
  • 테마 설정
• Sphinx 사용법
  • ReStructuredText 문법
  • 문서 계층 구조 구성하기
  • sphinx.ext.autodoc 사용법
  • sphinx.ext.autosummary 사용법
  • 확장 기능 사용법
  • Github Actions를 사용하여 Github Pages에 업로드 하기