sphinx-doc/sphinx-autobuild

어떤 프로젝트인가요?

핵심 기능

• 01소스 디렉터리의 파일이 변경되면 Sphinx 문서를 자동으로 다시 빌드합니다.
• 02각 빌드가 끝난 뒤 열려 있는 브라우저 창을 새로고침합니다.
• 03sphinx-build의 모든 인자를 지원하고 서버 및 감시 옵션을 추가로 제공합니다.
• 04감시 대상 파일에 glob 및 regex 제외 패턴을 적용할 수 있습니다.
• 05각 빌드 전후에 사용자 지정 명령을 실행합니다.
• 06사용 가능한 포트를 자동으로 선택하고 시작 시 브라우저를 열 수 있습니다.

활용 사례

• 변경 사항을 바로 확인하면서 프로젝트 문서를 작성하고 미리 봅니다.
• 테마 파일을 감시하면서 사용자 지정 Sphinx HTML 테마를 개발합니다.
• 서로 다른 포트와 출력 디렉터리를 사용해 여러 문서 프로젝트를 동시에 실행합니다.
• 빌드 전·후 훅을 통해 빌드 시작 및 완료 알림을 보냅니다.

빠른 시작

1. 1

   pip으로 PyPI에서 sphinx-autobuild를 설치합니다

   pip install sphinx-autobuild
2. 2

   서버를 시작하고 docs 디렉터리의 변경 사항을 감시합니다

   sphinx-autobuild docs docs/_build/html

사용 전 알아둘 점

• !유용하게 사용하려면 Sphinx 문서 프로젝트가 필요합니다.

포함된 컬렉션

토픽

자주 묻는 질문

sphinx-autobuild은(는) 무엇인가요?

Sphinx 문서 디렉터리를 감시하고, 변경 사항이 생기면 문서를 다시 빌드한 뒤 로컬 서버를 통해 브라우저를 새로고침하는 CLI 도구입니다. sphinx-autobuild는 Sphinx 소스 디렉터리를 감시하다가 파일이 변경되면 sphinx-build를 실행합니다. 기본적으로 생성된 HTML을 http://127.0.0.1:8000의 로컬 웹 서버에서 제공하며, 빌드가 끝날 때마다 열린 브라우저 창을 자동으로 새로고침하므로 직접 다시 빌드하거나 새로고침하지 않아도 수정 내용을 확인할 수 있습니다.

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

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

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

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

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

변경 사항을 바로 확인하면서 프로젝트 문서를 작성하고 미리 봅니다. 테마 파일을 감시하면서 사용자 지정 Sphinx HTML 테마를 개발합니다. 서로 다른 포트와 출력 디렉터리를 사용해 여러 문서 프로젝트를 동시에 실행합니다. 빌드 전·후 훅을 통해 빌드 시작 및 완료 알림을 보냅니다.

sphinx-autobuild는 어떻게 설치하나요?

pip으로 PyPI에서 sphinx-autobuild를 설치합니다: pip install sphinx-autobuild 서버를 시작하고 docs 디렉터리의 변경 사항을 감시합니다: sphinx-autobuild docs docs/_build/html

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

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