Welcome to qthelp docs.
This project aims to build documentation for use in the qt assistant using sphinx for the following projects:
- Python
- Numpy
- Scipy
- Sympy
- PySerial
- Matplotlib
- Tox
- Django
This is possible using sphinx documentation generation. It has a qthelp backend to generate qch (qt compressed help) files. This repository is merely a set of bash scripts to create the right documents.
To build the docs, simply run:
$ ./make_docs.sh
The documentation will be generated in the docs folder.
The .qch files can be included in the qt assistant for easy browsing. Open the qt assistant
- open the Qt Assistant
- Got to Edit -> preferences -> documentation tab
- Click add and select the .qch files you want to view.
Docs can be downloaded under releases of this github repository.
