sphinx은(는) 무엇인가요?

reStructuredText 또는 Markdown 소스에서 HTML, PDF, EPUB 등 다양한 형식의 문서를 생성하는 Python 문서 생성기입니다. Sphinx는 reStructuredText 소스 파일을 완성도 높은 문서로 변환하는 문서 생성기입니다. HTML, PDF, 일반 텍스트, EPUB, TeX, 매뉴얼 페이지 출력을 지원하며, 파싱과 변환에는 Docutils를 사용합니다.

sphinx은(는) 무료로 사용할 수 있나요? 라이선스는 무엇인가요?

sphinx은(는) Other 라이선스의 오픈소스입니다. 상업용 제품에 사용하기 전에 라이선스 조건을 확인하세요.

sphinx은(는) 아직 유지보수되고 있나요?

활발히 유지보수 중. sphinx의 마지막 커밋은 2026년 10월 22일입니다.

sphinx은(는) 어디에 사용할 수 있나요?

Python 라이브러리의 API 레퍼런스 문서를 게시할 때 하나의 소스에서 PDF와 HTML을 생성하는 기술 매뉴얼을 작성할 때 상호 참조가 있는 다국어 또는 버전별 프로젝트 문서를 관리할 때

sphinx는 어떻게 설치하나요?

pip으로 PyPI에서 Sphinx를 설치합니다: pip install -U sphinx

sphinx은(는) 어디서 받을 수 있나요?

소스 코드와 설치 방법은 GitHub에 있습니다: https://github.com/sphinx-doc/sphinx

sphinx-doc/sphinx

reStructuredText 또는 Markdown 소스에서 HTML, PDF, EPUB 등 다양한 형식의 문서를 생성하는 Python 문서 생성기입니다.

GitHub에서 보기 웹사이트

스타: 8,072
포크: 2,610
열린 이슈: 1,453
마지막 커밋: 7시간 전

어떤 프로젝트인가요?

Sphinx는 reStructuredText 소스 파일을 완성도 높은 문서로 변환하는 문서 생성기입니다. HTML, PDF, 일반 텍스트, EPUB, TeX, 매뉴얼 페이지 출력을 지원하며, 파싱과 변환에는 Docutils를 사용합니다.

이 도구는 상호 참조와 문서 구조에 중점을 둡니다. 함수, 클래스, 용어집 항목 등의 객체를 의미적으로 연결할 수 있으며, 문서는 트리 구조를 이루고 형제·상위·하위 문서 간 링크를 자동으로 생성합니다. 일반 색인과 모듈 색인도 자동으로 만들어 줍니다.

Sphinx는 Pygments를 사용해 코드 구문을 강조하고, Jinja 2 템플릿 엔진으로 HTML을 렌더링합니다. 확장 기능 생태계를 통해 함수 문서 자동 생성, Jupyter 노트북 지원, Python, C, C++, JavaScript 및 수학을 위한 언어 도메인 등의 기능을 추가할 수 있습니다.

핵심 기능

01HTML, PDF, 일반 텍스트, EPUB, TeX 및 매뉴얼 페이지로 출력합니다
02함수, 클래스, 용어집 항목을 의미적으로 상호 참조할 수 있습니다
03관련 문서 간 링크를 자동으로 생성하는 문서 트리를 구성합니다
04일반 색인과 모듈 색인을 자동으로 생성합니다
05Pygments로 코드를 강조하고 Jinja 2 템플릿으로 HTML을 렌더링합니다
06플러그인 생태계를 통해 확장할 수 있으며, Python, C, C++, JavaScript 언어 지원도 제공합니다

활용 사례

Python 라이브러리의 API 레퍼런스 문서를 게시할 때
하나의 소스에서 PDF와 HTML을 생성하는 기술 매뉴얼을 작성할 때
상호 참조가 있는 다국어 또는 버전별 프로젝트 문서를 관리할 때

빠른 시작

1
pip으로 PyPI에서 Sphinx를 설치합니다
pip install -U sphinx

사용 전 알아둘 점

README에는 명확한 라이선스 이름이 명시되어 있지 않습니다. 메타데이터에는 NOASSERTION으로 표시되어 있지만, 배지에는 BSD 2-Clause라고 표시되어 있습니다.

토픽

#documentation #restructuredtext #python #docs-generator #html #pdf #docs #documentation-tool #markdown #sphinx

자주 묻는 질문

sphinx은(는) 무엇인가요?: reStructuredText 또는 Markdown 소스에서 HTML, PDF, EPUB 등 다양한 형식의 문서를 생성하는 Python 문서 생성기입니다. Sphinx는 reStructuredText 소스 파일을 완성도 높은 문서로 변환하는 문서 생성기입니다. HTML, PDF, 일반 텍스트, EPUB, TeX, 매뉴얼 페이지 출력을 지원하며, 파싱과 변환에는 Docutils를 사용합니다.
sphinx은(는) 무료로 사용할 수 있나요? 라이선스는 무엇인가요?: sphinx은(는) Other 라이선스의 오픈소스입니다. 상업용 제품에 사용하기 전에 라이선스 조건을 확인하세요.
sphinx은(는) 아직 유지보수되고 있나요?: 활발히 유지보수 중. sphinx의 마지막 커밋은 2026년 10월 22일입니다.
sphinx은(는) 어디에 사용할 수 있나요?: Python 라이브러리의 API 레퍼런스 문서를 게시할 때 하나의 소스에서 PDF와 HTML을 생성하는 기술 매뉴얼을 작성할 때 상호 참조가 있는 다국어 또는 버전별 프로젝트 문서를 관리할 때
sphinx는 어떻게 설치하나요?: pip으로 PyPI에서 Sphinx를 설치합니다: pip install -U sphinx
sphinx은(는) 어디서 받을 수 있나요?: 소스 코드와 설치 방법은 GitHub에 있습니다: https://github.com/sphinx-doc/sphinx

요약은 프로젝트 README를 바탕으로 AI가 작성했습니다. GitHub 통계는 매일 갱신됩니다.