Add make target for docset to be used with Dash/Zeal

[johntyree]

This PR makes it simple to create a docset from the Traits html documentation, as used by the Dash and Zeal api browsers.

It assumes you have doc2dash installed and keeps all output under $(BUILDDIR).

The docset_html target lacks the left sidebar to make viewing in Dash/Zeal nicer. Unfortunately, sphinx does not support the notion of configuration files named anything other than conf.py and so we must make a directory docset_resources in which to hold the modified configuration. If there is a way to tell sphinx-build to override the html_theme_options dictionary then this directory is unneeded.

[enbuilder]

Merged build triggered. Test FAILed.

[enbuilder]

Merged build started. Test FAILed.

[enbuilder]

Merged build finished. Test PASSed.

[enbuilder]

Test PASSed.
Refer to this link for build results: http://jenkins.enthought.com:8080/job/Traits_PR_builder/57/

[enbuilder]

Merged build triggered. Test FAILed.

[enbuilder]

Merged build started. Test FAILed.

[enbuilder]

Merged build finished. Test PASSed.

[enbuilder]

Test PASSed.
Refer to this link for build results: http://jenkins.enthought.com:8080/job/Traits_PR_builder/58/

[mdickinson]

If there is a way to tell sphinx-build to override the html_theme_options dictionary

It would be worth looking for such a way. The duplication of conf.py files is unpleasant here.

[mdickinson]

How about setting an environment variable in the Makefile and inspecting that in conf.py?

[johntyree]

Hmm, yes that would be rather nicer than this approach. I'll try that later
today.
On May 8, 2014 4:22 AM, "Mark Dickinson" [email protected] wrote:

How about setting an environment variable in the Makefile and inspecting
that in conf.py?

—
Reply to this email directly or view it on GitHubhttps://github.com//pull/180#issuecomment-42529066
.

[coveralls]

Coverage increased (+0.71%) when pulling 43f3200 on feature/docset into af5baf7 on master.

[coveralls]

Coverage increased (+0.71%) when pulling 7b345aa on feature/docset into af5baf7 on master.

[dpinte]

@johntyree can you merged master in this PR? It would be good to get it merged.

[johntyree]

Glad to see this is still alive :)

[jvkersch]

Glad to see this is still alive :)

It's been plenty useful to me, but I always generate the docset and then forget to ping you on the PR!

@mdickinson If you have no objections, shall we merge this?

[mdickinson]

LGTM