Building Qt Documentation/ko

한국어 Русский Italiano Spanish 日本語 简体中文 English

[toc align_right="yes" depth="3"]

Qt 설명서 만들기

Qt에 대한 설명서를 작성하는 것과 관련된 정보는, Writing Qt Documentation 페이지를 참고하십시오.

트러블슈팅 설명서를 만드는 것과 관련된 도움을 받으려면, Troubleshooting Qt Documentation 페이지를 참고하십시오.

모듈화된 Qt 저장소에 설명서를 만드는 것과 관련된 정보는, Building Qt 5 Documentation 페이지를 참고하십시오.

Qt 5 설명서 만들기

Standard Qt 5 설치에 포함되어 있는 QDoc (qtbase의 qdoc 명령)으로 해당 설명서를 빌드합니다. 공식 Qt 설명서는 Linux 기반 머신으로 빌드되었으며, building Qt 5 에 필요한 라이브러리들을 요구하고, "supported desktop platforms":http://doc.qt.io/qt-5.0/qtdoc/supported-platforms.html 에서 테스트 되었습니다.

필요한 읽을거리

• Get the Source Code - Qt 소스 다운로드
• Building Qt 5 - Qt 5에 대한 지침 만들기

Qt 5 저장소 (qt5.git)의 표준 설치에서, Qt가 빌드되고 설치될 때 명령줄에 make docs 를 실행하면, QDoc 과 Qt 5 문서화 세트가 빌드될 것입니다. 해당 출력물은 qt5/qtbase/doc/ 또는 qmake의 QT_INSTALL_DOCS 변수에 설정된 디렉터리에 위치하게 될 것입니다.

<br />cd qt5/<br />make docs<br />

많은 경우, Qt 5 와 하위 모듈을 빌드할 필요가 없습니다. 해당 문서화를 빌드하기 위해선, qtbase에서 QDoc을 빌드하고 make docs 를 실행하기 전에 각 저장소에서 qmake_all 을 실행할 필요가 있습니다.

이 구성 단계를 마친 뒤 다음과 같이 하십시오:

<br />cd qt5/qtbase/src<br />make sub-qdoc #qdoc 바이너리를 빌드하기 위해<br />cd qt5/qttools<br />make #qhelpgenerator 를 빌드하기 위해<br />cd qt5/<br />make docs<br />

Windows일 경우, 이 대신 네이티브 nmake 도구를 사용하게 될 것입니다. qhelpgenerator가 qtbase에 또 다른 종속성을 갖고 있다는 점에 유의하십시오, 이런 이유로 qttools를 빌드하기 전에 qtbase를 먼저 빌드하는 것이 가장 좋습니다.

그렇지 않으면, "make html_docs"가 HTML 파일만 빌드하고 qch 패키지는 생성하지 않을 것입니다.

모듈 설명서 만들기

Qt 모듈들은, Qt 5 가 빌드되고 설치될 때 명령줄에서_make docs_ 를 실행하여 빌드된, 자체 설명서를 갖습니다.

<br />cd qt3d<br />make docs<br />

qdoc 직접 실행하기

문서화를 어디서 찾고 어떻게 설정하는지 QDoc에 알려주는 qdocconf 파일에 따라, QDoc 빌드가 지정됩니다. QDoc을 실행하려면, 인자로 qdocconf 파일과 출력 디렉터리를 넘기십시오.

<br />qdoc qt3d.qdocconf -outputdir html<br />

모듈화 된 설명서

각 모듈들은 src 디렉터리 내에 qdocconf 파일을 하나 갖고있습니다. 더 자세한 정보는 Qt_Documentation_Structure 페이지에 있습니다.

Qt4 설명서 만들기

Qt 를 Normal 빌드하십시오.

QT_SOURCE_TREE 및 QT_BUILD_TREE 환경 변수의 값을 적절하게 정의하십시오. PATH 환경 변수가 실행가능한 qdoc3 을 포함하는 bin 디렉터리를 가리키는지 확인하십시오.

<br />cd path/to/qt<br />make docs<br />

Qt 최신 버전에서, 온라인 문서를 위해서, 아래를 사용할 필요가 있습니다.

<br />cd path/to/qt<br />make online_docs<br />

Windows™ 에서는 make 대신 nmake 유티리티를 사용하십시오. 몇몇 Linux 시스템에서는 make 대신 gmake 를 요구할 것입니다.

만약 여러분이, 컴파일된 Qt (예를 들면, SDK에서 제공한)를 이미 가지고 있다면, 문서를 약간 특별한 분위기로 만들고 싶은 경우, qdoc3 (QT_SOURCE_TREE, QT_BUILD_TREE, 그리고 QTDIR 가 각각 적절하게 설정되어야 합니다.)를 직접 호출할 수 있습니다, DITA 출력은 아래를 보십시오:

<br />cd qt-src<br />bin/qdoc3 tools/qdoc3/test/qt-ditaxml.qdocconf<br />