qiurui
/
qtdoc
mirror of https://github.com/qt/qtdoc.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Doc: Updated the README file. 

-updated "make docs" command information.

Change-Id: Id102998481e15327980221586aef528edb541b6c
Reviewed-by: Jing Bai <jing.bai@digia.com>
This commit is contained in:
Jerome Pasion 2012-12-04 17:11:55 +01:00 committed by The Qt Project
parent 30f160b104
commit a83c183c69
1 changed files with 22 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
README
View File

@ -30,7 +30,7 @@ Section 1 Building the qdocconf File
qdocconf file as a parameter. "qdoc" is found in qtbase repository. A
mandatory "outputdir" must be specified.
$> qdoc doc/config/qt-project.qdocconf -outputdir html
$> qdoc doc/config/qtdoc.qdocconf -outputdir html
Note that QDoc will delete the contents of the "html" output directory.
@ -53,7 +53,18 @@ Section 2 Building using make
there will generate the documentation for Qt 5 and install them to the
path set to the QT_INSTALL_DOCS variable.
Section 3 Packaging the Documentation
Section 3 Building Qt Documentation
To build the Qt module documentation along with the Qt Reference Documentation,
run the following:
$> cd qt5 #the main qt5.git directory
$> make qmake_all #creates Makefiles for each repository
$> make docs
To generate only HTML files, run "make html_docs" instead of "make docs"
Section 4 Packaging the Documentation
To package the documentation for Qt Assistant, the HTML files must be
compiled into a QCH file (.qch).
@ -67,9 +78,17 @@ Section 3 Packaging the Documentation
$> cd qtbase/doc/qtdoc #the default path for QT_INSTALL_DOCS for qtdoc
$> qhelpgenerator qtdoc.qhp #creates the QCH file called qtdoc.qch
Alternatively, modules have a "qch_docs" target:
$> cd qtbase
$> make qch_docs #builds the QCH files for modules in qtbase
The QCH file can then be loaded in Qt Assistant or Qt Creator. For Qt
Assistant, the QCH file may be registered to automatically load it.
$> assistant -register qtdoc.qch #to automatically load the documentation
Section 4 More Information
Section 5 More Information
For more information about Qt 5's documentation, refer to the Qt Project wiki:
http://qt-project.org/wiki/Qt5DocumentationProject