Full width home advertisement

Post Page Advertisement [Top]

If you want to see documentation for your applications in Qt Assistant

1. Add qthelp section in your Makefile (replace MyAppName with your own, "IPython" for example) :


qthelp:
mkdir -p build/qthelp
$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) build/qthelp
@echo
@echo "Build finished; now you can run qcollectiongenerator" with the" \
     ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/IPython.qhcp"
@echo "To view the help file:"
@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/IPython.qhc"

2. Run :
make qthelp
qcollectiongenerator build/qthelp/MyAppName.qhcp


3. You can preview created documentation:
assistant -collectionFile build/qthelp/MyAppName.qhc

4. Close Assistant and run it from your desktop environment menu or type in terminal:
assistant

5. Add created collection file in Edit - Preferences - Documentation. That should look like this :

6. Click "Add" button and select your .qhc file that was created before. You will see your application's documentation in "Contents" field. Search tool will be working too.

P.S. If you want to use Twitter Bootstrap theme in your sphinx documentation, you can use http://pypi.python.org/pypi/sphinx-bootstrap-theme (I'm not developer of that).

Комментариев нет:

Отправить комментарий

Bottom Ad [Post Page]

| Дизайн Colorlib