다음에 읽을 내용¶
당신은 지금까지 소개 자료를 모두 읽었으며 Django를 계속 사용하기로 결정했습니다. 하지만 우리는 이 소개 자료로 그저 겉핥기를 했을뿐 입니다 (실제로 단어수로 세어보면 전체 문서의 약 5%를 읽은것 입니다.).
그럼 다음은 뭘 하죠?
글쎄요, 우린 항상 해보는것을 통한 배움의 열성팬이었습니다. 이 시점에서 자신의 프로젝트를 시작할 수 있는 충분한 지식을 가지고 있으며 무언가 잘 안 되어 새로운 트릭을 배워야 할 때 문서로 돌아가십시오.
Django의 문서를 유용하고 읽기 쉽고 가능한 한 완벽하게 만들기 위해 많은 노력을 기울였습니다. 이 문서의 나머지 부분에서는 문서가 어떻게 이루어지에 대해 자세히 설명하므로 사용자가 이를 최대한 활용할 수 있습니다.
(예, 이것은 문서에 대한 문서입니다. 문서에 대한 문서를 읽는 방법에 대한 문서를 작성할 계획이 없으니 안심하십시오.)
문서 찾기¶
Django는 많은 문서를 가지고 있습니다. 거의 450,000 단어가 포함되어 있습니다. 그래서 당신이 필요로하는 것을 찾는것이 때때로 까다로울 수 있습니다. 시작하기 좋은 곳은 검색 페이지와 색인입니다.
아니면 그냥 둘러 볼 수 있습니다!
이 문서의 구조¶
Django의 주요 문서는 서로 다른 필요를 채우기 위해 설계된 "덩어리"로 나뉩니다.
소개 자료는 Django를 처음 접하는 사람들이나 일반적으로 웹 개발을 위해 고안되었습니다. 깊이있는 내용은 다루지 않지만 대신 Django의 개발이 어떻게 느껴지는 지에 대한 고차원적인 개요를 제공합니다.
반면에 주제 가이드는 장고의 각 부분에 깊이 들어가 있습니다. Django에 대한 완전한 가이드가 있습니다 모델 시스템, 템플릿 엔진, 폼 프레임워크, 그리고 이외에 더 많은것들이 있지요.
아마도 여기서 대부분의 시간을 보내고 싶어 할 것입니다. 이 가이드를 통해 길을 찾으면 장고에 대해 알아야 할 모든 것을 알게됩니다.
웹 개발은 종종 광범위하지 않고 심층적이지 않은 문제가 많은 영역에 걸쳐 있습니다. 우리는 공통적인 "어떻게 해야 합니까?"에 대해 답하는 how-to 가이드 세트를 작성했습니다. Django로 PDF 생성하기, 사용자 정의 템플릿 태그 작성하기 등의 정보를 찾을 수 있습니다.
정말로 일반적인 질문에 대한 답은 FAQ 에서도 찾을 수 있습니다.
가이드와 하우투는 장고에서 사용 가능한 모든 클래스, 함수 및 메소드를 다루지는 않습니다. 이는 그저 배우려고 할 때 보기에는 좀 지나친 것입니다. 대신 개별 클래스, 함수, 메소드 및 모듈에 대한 세부 정보는 reference 에 보관됩니다. 여기서 특정 기능 또는 원하는 기능의 세부 정보를 찾을 수 있습니다.
공개적으로 프로젝트를 배포하는 데 관심이 있다면, 다양한 배포 설정을 위한 여러 가지 안내서 뿐만 아니라 생각해볼 만한 배포 체크리스트 가 있습니다.
마지막으로, 대부분의 개발자와 관련이없는 "전문화 된" 문서가 있습니다. 이것은 장고 자체에 코드를 추가하고자하는 사람들을 위해 release notes 와 internals documentation 를 포함하고 있습니다. 그리고 단순히 다른 곳에 적합하지 않은문서들도 있구요.
문서는 어떻게 업데이트 되는가¶
Django 코드 기반이 매일 개발되고 개선되는 것처럼 우리의 문서는 지속적으로 개선되고 있습니다. 몇 가지 이유로 문서를 개선합니다.
- 문법/오타 수정과 같은 내용 수정.
- 확장해야 할 기존 섹션에 정보 또는 예제를 추가합니다.
- 아직 문서화되지 않은 Django 기능을 문서화합니다. (이러한 기능 목록은 줄어들지 만 그럼에도 불구하고 존재합니다.)
- 새로운 기능이 추가되거나 Django API 또는 동작이 변경됨에 따라 새로운 기능에 대한 문서를 추가 할 수 있습니다.
Django의 문서는 코드와 동일한 소스 제어 시스템에 보관됩니다. 그것은 Git 저장소의 docs 디렉토리에 있습니다. 온라인상의 각 문서는 저장소에있는 별도의 텍스트 파일입니다.
어디서 구할 수 있습니까?¶
Django 문서는 여러 가지 방법으로 읽을 수 있습니다. 그들은 선호 순서대로:
웹에서¶
Django 최신 버전 문서는 https://docs.djangoproject.com/en/dev/에 있습니다. 소스 컨트롤의 텍스트 파일에서 이 HTML 페이지들이 자동으로 생성됩니다. 즉 Django의 "최신이자 최고"가 반영됩니다. 최신 수정 및 추가사항을 포함하며, Django 개발 버전에만 있을 수도 있는 최신 Django 기능을 다룹니다.(아래의 버전 간 차이점 참조)
ticket system에서 변경 사항, 수정 사항 및 제안 사항을 제출하여 문서 개선에 도움을 받으시기 바랍니다. Django 개발자는 티켓 시스템을 적극적으로 모니터링하고 여러분의 피드백을 사용하여 모든 사람의 문서를 개선합니다.
그러나 티켓은 광범위한 기술 지원 질문을 하기보다는 문서와 명시적으로 관련되어야합니다. 특정 장고 설정에 대한 도움이 필요하면 django-users 메일링 리스트 또는 #django IRC channel을 사용하세요.
일반 텍스트¶
오프라인 읽기 또는 편의를 위해 Django 문서를 일반 텍스트로 읽을 수 있습니다.
Django 공식 릴리스를 사용하고 있다면, 코드의 압축된 패키지(tarball)에 docs/ 디렉터리가 있으며, 그곳에 해당 릴리스 문서가 있습니다.
Django 개발 버전(마스터 브랜치)을 사용하고 있을 경우 docs/ 디렉터리에 모든 문서가 있습니다. 최신 변경사항을 얻으려면 Git checkout한 것을 갱신할 수 있습니다.
텍스트 문서를 활용하는 하나의 낡은 기술은 Unix의 grep 유틸리티를 사용하여 모든 문서에서 문구를 검색하는 것입니다. 예를 들어 이 명령은 Django 문서에서 "max_length" 라는 문구가 언급된걸 보여줍니다:
$ grep -r max_length /path/to/django/docs/
...\> grep -r max_length \path\to\django\docs\
로컬 HTML¶
몇 가지 간단한 단계를 거치면 HTML 문서의 로컬 복사본을 얻을 수 있습니다.
Django의 문서에서는 Sphinx라는 시스템을 사용하여 일반 텍스트를 HTML로 변환합니다. Sphinx 웹 사이트에서 패키지를 다운로드하고 설치하거나 "pip"로 설치해야합니다.
$ pip install Sphinx...\> pip install Sphinx그런 다음, 포함된
Makefile을 사용하여 문서를 HTML로 변환하십시오.$ cd path/to/django/docs $ make html
이것을 위해 GNU Make가 설치되어 있어야 합니다.
Windows를 사용하는 경우 포함 된 배치 파일을 대신 사용할 수 있습니다.
cd path\to\django\docs make.bat htmlHTML 문서는
docs/_build/html에 있습니다.
버전 간 차이점¶
Git 저장소의 마스터 브랜치에 있는 텍스트 문서는 "최신이자 최고"의 변경 및 추가 사항을 포함합니다. 이러한 변경은 Django의 차기 feature release를 목표로 하는 새로운 기능의 문서를 포함합니다. 이러한 이유로, Django의 최신 변경 및 추가 사항을 강조하기 위한 우리의 정책을 짚고 넘어갈 필요가 있습니다.
우리는 다음과 같은 정책을 따릅니다.
- https://docs.djangoproject.com/en/dev/의 개발 문서는 마스터 브랜치로부터 나옵니다. 이러한 문서는 최신 기능 릴리스 및 그 이후에 프레임워크에 추가/변경된 모든 기능과 대응됩니다.
- Django의 개발 버전에 기능을 추가함에 따라, 같은 Git 커밋 트랜잭션에 문서를 갱신합니다.
- 문서에서 기능 변경/추가를 구분하기 위해, 아직 릴리스되지 않은 Django 버전에 대해서는 "New in Django Development version"으로, 릴리스된 버전에 대해서는 "New in version X.Y"로 표현합니다.
- 문서 정정 및 개선은 커미터의 재량에 따라 최신 릴리스 브랜치에 백포트될 수 있습니다. 그러나, Django 버전이 더 이상 지원되지 않는 경우, 해당 버전 문서는 갱신되지 않습니다.
- main documentation Web page는 문서에 대한 링크를 포함합니다. 사용하는 Django 버전에 해당하는 문서를 사용하는지 확인하세요!
