id	summary	reporter	owner	description	type	status	component	version	severity	resolution	keywords	cc	stage	has_patch	needs_docs	needs_tests	needs_better_patch	easy	ui_ux
21558	Build CHM help file format out of box on win32	Michał Pasternak	nobody	"Hi,

CHM file format is Microsoft Help file Compiled HTML Help format and for me and perhaps some other people, it is very convinient to use it[1]. In the past, various individuals([2], [3]) built their own, unofficial CHM files by hand. Also, there are other projects, not less prominent, than ours beloved Django ([4], [5], [6]), who happily provide CHM help on their official pages. 

So, why aren't we doing that? Let's fix this now. 

For the CHM help file building... why do it by hand, when we are already using Makefiles to build documentation?

Modify the Makefile... done!

Another problem: the files compiled by Sphinx can not be feed to Microsoft Help Compiler, because of included JQuery (https://code.djangoproject.com/ticket/14950), which caused errors on every page opened. This is relativley easy to fix, by using sphinx-build command line switch -A, which feeds variables directly to template rendering context. 

So, in the commit linked to this issue, I am fixing both 14950 _and_ I am including call to Microsoft Help Compiler, to build the required CHM file, so perhaps in the future our project would be able to provide CHM help files for those win32-based djangonauts out there. And, the make.bat contains a link to Microsoft Help Compiler download, if anybody does need that. 

The errorlevel checking part is a bit strange for anybody using a regular shell like bash or zsh, it is explained here [7]. 

So, what do you say, guys? I will include the patch in the comment as soon as I add this issue to tracker, so I can use its number in the commit...


Links:
1. Comments below this article http://blog.pythonaro.com/2009/08/django-11-help-file-chm-version.html for example
2. http://www.aryehleib.com/CHM.html
3. http://blog.pythonaro.com/2009/08/django-11-help-file-chm-version.html
4. http://php.net/download-docs.php
5. http://rubyinstaller.org/downloads/
6. http://python.org/download/releases/2.7.6/
7. http://www.incodesystems.com/PRODUCTS/ERRORLE1.HTM"	Bug	closed	Documentation	1.6	Normal	fixed	html help chm generation docs		Accepted	1	0	0	0	1	0