Skip to content

ENH: add HTML Help builder option #3325

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 2 commits into from
Jul 31, 2014
Merged

ENH: add HTML Help builder option #3325

merged 2 commits into from
Jul 31, 2014

Conversation

cgohlke
Copy link
Contributor

@cgohlke cgohlke commented Jul 29, 2014

This patch allows to build documentation in HTML Help format. See also discussion on matplotlib-devel.
On Windows, some symlinks need to be created manually before running python make.py --small htmlhelp:

del mpl_examples
del mpl_toolkits\axes_grid\examples
mklink /D mpl_examples  ..\examples\
mklink /D mpl_toolkits\axes_grid\examples ..\..\..\examples\axes_grid\

The CHM file, Matplotlibdoc.chm, can then be generated with hhc.exe Matplotlibdoc.hhp.
The HTML Help compiler, hhc.exe, is part of the Microsoft HTML Help Workshop 1.3.

@tacaswell tacaswell added this to the v1.4.0 milestone Jul 29, 2014
tacaswell added a commit that referenced this pull request Jul 31, 2014
@tacaswell
Merge pull request #3325 from cgohlke/patch-1
939b5be 
ENH: add HTML Help builder option
@tacaswell tacaswell merged commit 939b5be into matplotlib:v1.4.x Jul 31, 2014
@nepix32 nepix32 mentioned this pull request Sep 1, 2014
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
v1.4.0
Development

Successfully merging this pull request may close these issues.
2 participants
@cgohlke @tacaswell