Sphinx

[andreikop]

No description provided.

[andreikop]

Hi, Bryan

I tried to make the settings UI and code more simple. This is complicated task. Here is my progress.
The changes:

• CodeChat and Sphinx settings page now has common name Literate programming
• CodeChat and Sphinx help texts are not included to checkable area, so we don't have to do hacks to enable/disable it manually
• When Sphinx project is disabled, only project-related settings are disabled, but user still can edit path
• Path is always visible. So, user can check if Sphinx binary exists even in advanced mode

Currently one of the links is blue (but not gray) even if enabled. I'll fix it if necessary. Read my comments below.

This is not a final variant, but work in progress. What do you think about it?

Some more questions:

• Is it really necessary to have advanced mode? Now we use outputPath and projectPath to find and open HTML file. If user changed any path or output format in advanced mode, we will not be able to preview document.
• In Normal mode user can choose output format. Same case again. Preview would be broken, since it can read only html. I think we should drop this setting and generate HTML for preview. If user wants to generate something else, let him to use cmdline sphinx-build without Enki.

[bjones1]

Andrei,

Wow, that is much nicer. Thanks for your time and attention.

In terms of your questions:

• I like advanced mode, for two reasons. First, it lets advanced users add command-line options...at the danger of breaking Enki's ability to find the resulting html files. I think this is OK -- it's advanced mode. Second, it's a possibility for the future: users could run other builders here (rst2html with switches, doxygen, javadoc) and Enki could still view them, if we add code to find the .html files.
• This might be a problem of poor naming: it should be something like output file extension, not output format, since changing the value here doesn't change the contents (i.e. Sphinx is still produce HTML). There's a Sphinx conf.py setting that specifies this, so I wanted Enki users to be able to match that. The output will still be html, regardless of the setting -- the intention is to support .htm, .xhtml, etc. So I think this won't confuse our users.