生成 Qt 文檔

我的總結

   從命令行進入Qt安裝目錄

    設置環境變量

    set path=D:/mingw32/bin;D:/Qt/5.0.0/qtbase/bin;D:/icu/bin;D:/icu/lib

    

    運行 mingw32-make docs

    

    進入到qtbase/doc

    將qtdoc.qch註冊到asstant

    assistant -register qtdoc.qch

========================================================================

翻譯自qtdoc下面的readme

    qtdoc涵蓋了Qt主要的參考文檔，包括include，oveviews，Qt topics，以及非特定模塊的example。其配置文件位於qtdoc/doc/config,文本內容位於qtdoc/doc/sc。須要指出的是 QDoc位於qtbase下面。

    本教程假設所需工具均已編譯好，而且正確設置在環境變量PATH%中（在須要的時候可以被其餘程序和命令找到）。

前提條件：
    *qtbase存在
    *qmake和qdoc已經編譯和安裝好
    *要用到的Qt資源存在

    Qt參考文檔中各個模塊以連接的形式存在。若某個模塊或者資源不存在，那麼生成的文件中將包含若干死鏈。

    有兩種方法得到文檔。一種是使用QDoc和配置文件(qdocconf)來編譯文檔，對應一；另外一種方法是運行qmake(命令爲make docs)，對應2、三。

1、使用qdocconf文件進行構建

    這種方法適用於構建不依賴其餘項目的單獨項目。

    運行qdoc，使用qdocconf文件(文件路徑)做爲其參數(輸入)。qdoc位於qtbase資源中。另一個強制參數是outputdir，用於指定文檔的安裝目錄(輸出)

    $> qdoc doc/config/qtdoc.qdocconf -outputdir html

    注意：QDoc會將安裝目錄html下全部內容刪除清空。

2、使用make命令進行構建

    QMake從變量QT_INSTALL_DOCS獲取Qt5文檔的安裝位置。這個方法產生的文檔能夠連接到其餘模塊。

    使用如下命令查看文檔的安裝位置(即變量QT_INSTALL_DOCS所指示的路徑)：

    $> qmake -query

    生成文檔：   

    $> cd qtdoc #or whichever repository's root
    $> qmake
    $> make docs

    make docs在Qt5總資源中一樣能夠工做。在其中運行這個命令會生成Qt5文檔，而且將其安裝到QT_INSTALL_DOCS所指示的位置

3、構建Qt文檔

    使用以下命令將Qt模塊文檔與Qt參考文檔一塊兒進行構建：

    $> cd qt5 #the main qt5.git directory
    $> make qmake_all #creates Makefiles for each repository
    $> make docs

    將make docs替換成make html_docs能夠只生成HTML文件。

4、打包文檔   

    若是須要在QtAssitant中瀏覽文檔，全部html文件都必須編譯打包成QCH文件(.qch)

   所需工具
   *assistant      - 可以在qttools中找到
   *qhelpgenerator - 可以在qttools中找到

    爲每一個模塊編譯qch文件：進入到輸出目錄(含有.qhp文件)，編譯生成QCH文件。

    輸出目錄即變量QT_INSTALL_DOCS所指示的路徑。

    $> cd qtbase/doc/qtdoc           #QT_INSTALL_DOCS默認值
    $> qhelpgenerator qtdoc.qhp      #建立名爲qtdoc.qch的QCH文件

    或者，當模塊含有一個qch_docs目標項時:

    $> cd qtbase
    $> make qch_docs #builds the QCH files for modules in qtbase

    QCH文件如今可以被Qt Assistan或Qt Creator載入。若是想要Qt Assistant自動載入它們，還須要進行註冊：

    $> assistant -register qtdoc.qch
       #註冊文檔，使assistant自動將其加載