Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Hello #1

Open
QianwenZhu opened this issue Mar 14, 2017 · 6 comments
Open

Hello #1

QianwenZhu opened this issue Mar 14, 2017 · 6 comments

Comments

@QianwenZhu
Copy link

I want to get pyqt5 API in chm format and have downloaded qt-documentation-chm-5.7.0-1 and decompressed it. There are 5 files: chm.py, LICENSE.txt, main.py, README.md, style.sass.

I ran python main.py in command line, but nothing was created. Did I make some mistakes?(I have created folder named as /complete/output and /complete/source before ran main.py).

Thank you in advance.

@char101
Copy link
Owner

char101 commented Mar 15, 2017

I think you need to download the Qt-5.7.0.chm.zip instead.

If you want to build it yourself, you'll need the HTML files from an existing Qt installation or from a prebuilt linux package e.g. https://www.archlinux.org/packages/extra/any/qt5-doc/.

@QianwenZhu
Copy link
Author

I tried downloading Qt-5.7.0.chm.zip for several times, but always failed.(Maybe caused by the fire wall in China).

And I have downloaded the package from https://www.archlinux.org/packages/extra/any/qt5-doc/ and decompress it. There are a lot of .qch files such as activeqt.qch, qtdoc.qch and so on, how can I use them to generate chm?

@char101
Copy link
Owner

char101 commented Mar 15, 2017

The qch files are not required. You'll need to extract the html files and directories in usr/share/doc/qt to the complete/source directory.

So the commands required are something like this (untested)

$ git clone https://github.com/char101/qt-documentation-chm
$ cd qt-documentation-chm
$ mkdir complete
$ tar xvJf qt5-doc-5.8.0-2-any.pkg.tar.xz
$ mv usr/share/doc/qt complete/source
$ python main.py

@char101
Copy link
Owner

char101 commented Mar 15, 2017

After that you'll need to compile the htmlhelp project (*.hhp) in the complete/output directory using htmlhelp workshop. Of course this should be done in Windows. The example commands I gave before are Linux commands since Windows commands are less powerful - you'll probably do it by using the file explorer, but it is hard to show the steps using explorer, so I gave the examples using Linux commands.

@char101
Copy link
Owner

char101 commented Mar 15, 2017

Also you'll need to compile style.sass to style.css. There's a lot of tools for that.

@QianwenZhu
Copy link
Author

Thank you very much for your detailed answer ! Came back late today. I'll try your steps tomorrow.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants