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

WIP: Create extra files needed for htmlhelp docs #1051

Open
wants to merge 3 commits into
base: wxPy-4.0.x
Choose a base branch
from

Conversation

RobinD42
Copy link
Member

Fixes #966

@RobinD42
Copy link
Member Author

Currently this is not quite working right. The htmlhelp project, index, etc. files are generated by sphinx, but the HtmlHelp Compiler is crashing when run.

@RobinD42
Copy link
Member Author

RobinD42 commented Nov 9, 2018

Apparently the MS help compiler tool has a bug that causes it to crash when there is a . in the middle of a filename (not including the final extension part of the name), or in a folder name, which is followed by an h which causes the tool to try and parse the file as if it was HTML. Even better, this bug has been around for at least a couple decades.

Unfortunately we end up with a ton of files with a .h in the name, like:

_static\images\inheritance\wx.HScrolledWindow_inheritance.png
_static\images\inheritance\wx.HScrolledWindow_inheritance.png.map

So it would take a significant reworking of the document generating and building code to make building a .chm help file possible.

@RobinD42
Copy link
Member Author

RobinD42 commented Nov 9, 2018

FTR:

 >  hhc wxPythonDocs.hhp
Microsoft HTML Help Compiler 4.74.8702

Compiling c:\projects\wx\git\Phoenix\docs\html\wxPythonDocs.chm

HHC3004: Warning: wx.HScrolledWindow_inheritance.png : The HTML tag "√╠{ⁿyy═£Ö3{╬▐│≈√Hƒf∩o¡╜~┐⌡╬┌{µ╠Y≥┌k»²¿0╞ÿÄ│ñ≈jî1¥╞..." is not a valid HTML tag (it does not begin with an alphanumeric character).
HHC3004: Warning: wx.HScrolledWindow_inheritance.png : The HTML tag "µ▌─b8&�├÷ß1∩&�├1▒�╢�Åy7▒�Äë┼░}x╠╗ë┼pL,åφ├c▐M,åcb1l..." is not a valid HTML tag (it does not begin with an alphanumeric character).
HHC3004: Warning: wx.HScrolledWindow_inheritance.png : The HTML tag "µ▌─b8&�├÷ß1∩&�├1▒�╢�Åy7▒�Äë┼░}x╠╗ë┼pL,åφ├c▐M,åcb1l..." is not a valid HTML tag (it does not begin with an alphanumeric character).
HHC3004: Warning: wx.HScrolledWindow_inheritance.png : The HTML tag "δΣÖº1f8,åC2M�D°╟Zì��ï≡gz|EÑ╔≡lô┐2±╫hî�ïßê4²╟�ⁿc..." is not a valid HTML tag (it does not begin with an alphanumeric character).
HHC3004: Warning: wx.HScrolledWindow_inheritance.png : The HTML tag "≈▄ÅJ±ÉHÇ╩╩φ√ y╙·)ô■╥�·ú▌úá¼x�▒Ä~}J█æ╓═╣v}² �,├ÿ:..." is not a valid HTML tag (it does not begin with an alphanumeric character).
HHC3004: Warning: wx.HScrolledWindow_inheritance.png : The HTML tag "è¿₧�µ─��┬$��·Y±û╖<PèßYgm)₧~·{╜öY¿ç▓��Ä)�(úƒÇΣ─É≤(┤..." is not a valid HTML tag (it does not begin with an alphanumeric character).
HHC3004: Warning: wx.HScrolledWindow_inheritance.png : The HTML tag "≥E?╟"ª≈3]w°≡╤╧;∩sσ╬pσ╩/ò»√≈ ñL�Στ:êφÆiº�iÜ�   rτÉ÷..." is not a valid HTML tag (it does not begin with an alphanumeric character).
Segmentation fault

@RobinD42 RobinD42 changed the title Create extra files needed for htmlhelp docs WIP: Create extra files needed for htmlhelp docs Jan 3, 2019
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

Successfully merging this pull request may close these issues.

1 participant