readthedocs/readthedocs.org

어떤 프로젝트인가요?

핵심 기능

• 01Git 저장소에서 문서 소스를 직접 가져옵니다.
• 02푸시할 때마다 Sphinx 및 MkDocs 프로젝트를 자동으로 빌드합니다.
• 03문서의 여러 버전을 관리하고 제공합니다.
• 04빌드된 문서를 공개 또는 비공개 사이트로 호스팅합니다.

활용 사례

• 오픈소스 프로젝트의 공개 API 또는 라이브러리 문서를 호스팅합니다.
• 커밋할 때마다 업데이트되는 팀 내부 문서를 게시합니다.
• 사용자가 설치된 버전에 맞는 릴리스 문서를 읽을 수 있도록 버전별 문서를 제공합니다.

빠른 시작

1. 1

   GitHub 계정으로 Read the Docs에 가입하세요

2. 2

   GitHub에서 요청하면 리포지토리 액세스를 허용하세요

3. 3

   로그인한 다음 "프로젝트 추가"를 클릭하고 리포지토리를 선택한 뒤 "계속"을 클릭하세요

4. 4

   프로젝트 세부 정보를 검토하고 "다음"을 클릭한 뒤, 커밋을 push하면 문서가 자동으로 업데이트됩니다

사용 전 알아둘 점

• !호스팅 서비스는 문서 프로젝트용으로 설계되었으며, 플랫폼 전체를 직접 호스팅하려면 상당한 노력이 필요합니다.
• !코드베이스는 종속성이 많은 대규모 Django 애플리케이션이므로 로컬 개발 환경을 설정하는 데 품이 많이 듭니다.

포함된 컬렉션

토픽

자주 묻는 질문

readthedocs.org은(는) 무엇인가요?

Git 저장소의 문서를 자동으로 빌드하고 버전을 관리해 호스팅하는 오픈소스 플랫폼으로, Sphinx와 MkDocs를 지원합니다. Read the Docs는 오픈소스 프로젝트와 팀의 문서를 호스팅합니다. Git 저장소에서 문서를 가져와 Sphinx(reStructuredText)나 MkDocs(Markdown) 같은 도구로 빌드한 다음, 호스팅 사이트에 게시합니다.

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

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

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

활발히 유지보수 중. readthedocs.org의 마지막 커밋은 2026년 11월 6일입니다.

readthedocs.org은(는) 어디에 사용할 수 있나요?

오픈소스 프로젝트의 공개 API 또는 라이브러리 문서를 호스팅합니다. 커밋할 때마다 업데이트되는 팀 내부 문서를 게시합니다. 사용자가 설치된 버전에 맞는 릴리스 문서를 읽을 수 있도록 버전별 문서를 제공합니다.

readthedocs.org는 어떻게 설치하나요?

GitHub 계정으로 Read the Docs에 가입하세요 GitHub에서 요청하면 리포지토리 액세스를 허용하세요 로그인한 다음 "프로젝트 추가"를 클릭하고 리포지토리를 선택한 뒤 "계속"을 클릭하세요 프로젝트 세부 정보를 검토하고 "다음"을 클릭한 뒤, 커밋을 push하면 문서가 자동으로 업데이트됩니다

readthedocs.org은(는) 어디서 받을 수 있나요?

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