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

[suggestion][docs] HTMLHelp format documents in extras #966

Open
GadgetSteve opened this issue Aug 16, 2018 · 1 comment
Open

[suggestion][docs] HTMLHelp format documents in extras #966

GadgetSteve opened this issue Aug 16, 2018 · 1 comment

Comments

@GadgetSteve
Copy link
Contributor

Operating system: ALL
wxPython version & source: (pypi, self-built, etc.) All versions, https://extras.wxpython.org/wxPython4/extras/
Python version & source: (stock, anaconda, EDM, distro, self-built, etc.) All & Any

Description of the problem: Currently the extras documents downloads have to be unzipped so as to be viewed in the users web browser, currently this is a 24 MB download which unzips to a massive 7846 files totalling 100 MB, (with much more space used due to disk cluster allocation. If the documents were also built to http help format, (I notice that this is an existing target in the Sphinx make file), and was provided, (pre-built), in zip format with the .hhp file at the root then the wx helpviewer app should be able to open the documents while still zipped. (I was unable to build the htmlhelp version to test this out as the machine that I am on at the moment suffers from the "buildtools" issue.

The wxdocs utility could then be modified to download the htmlhelp zip package and to invoke the helpview application with the zip file as an input.

# Sample code not applicable to this ticket!
@RobinD42
Copy link
Member

Unfortunately the helpviewer tool is still based on wxHtmlWindow, which can't handle the level of HTML/CSS used in the docs. Try removing all the .css and .js files and then view the docs in your browser to get an idea of what it would look like. I had expected that the html help controller classes would have switched over to wxWebView by now, but still waiting on that...

We could build a .chm file from the docs. The Windows buildbot node already has the MS Html Help Compiler installed, IIRC. Last I checked, however, the options for viewing these files was pretty limited on Linux and OSX. (Either old, unmaintained, or klunky options.)

I'll go ahead and switch the sphinx command to use the htmlhelp format, so the extra files will be generated. But the building and uploading of the chm file will probably have to wait for later or a PR.

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