Sphinx html

[bjones1]

Finally -- adds the ability to run Sphinx to the preview window.

[andreikop]

Wow!!! Bryan, Pan, huge and cool job! I've made some comments during reading the changes. Mainly about the UI.

Few more things:

Simple:

• Sphinx is usable as is, even without CodeChat. How about making separate settings page for it?
• I got some test failures. CodeChat is not installed on the system where the tests were executed, but sphinx-build is installed. See the log

Difficult:

• Sphinx settings contain project path. But, project path is a local setting for concrete file or project, not a global setting. I can work on a few projects simultaneously even in 1 Enki instance. Now Enki doesn't have any conception of current project and I don't know how to solve the problem easily. Any ideas?

[bjones1]

Thanks! It was a lot more work than I realized. Pan did a great job and wrote a lot of it.

Re: Sphinx on a separate page: will do. We wondered what made sense and could see it either way (as a separate page or not).

Re: test failures -- we'll fix. They somehow slipped through.

I don't have any good ideas on a current project. Options I can think of:

• A separate dialog or window, allowing the user to create, enable/disable, and remove Sphinx projects. Works, but sounds awkward for the user.
• Perhaps integrate a button or right-click menu into the file explorer (right-click then Enable Sphinx project here)? But then, how to allow the user to see the list of projects and settings, enable/disable, etc.?

[andreikop]

Bryan, Pan Hejia, have you finished doing the changes?

[bjones1]

Almost -- just one more fix and we'll be ready, hopefully done by today.

[bjones1]

OK, done. Would you take a look?

[andreikop]

Cool. Will review asap

[andreikop]

I've opened a reverse pull request

[andreikop]

Continuing here discussion from the reverse pull request

Advanced mode

I'd prefer to have simple preview functionality which always works, and add new code ( or even new plugins) for Doxygen etc. But OK, let's leave the advanced mode.

Output file extension

I've checked the code and now understand how it works. And I think we should remove output extension combobox because

• It confuses a user. If I see editable control in the settings, I'm sure it will change something. This could be fixed by better naming
• I think we must not ask a user for information which can be mined by code. It is annoing for users, and configuration will often be incorrect. Humans do make mistakes and never read documentation.

We might parse conf.py, but I think it is better idea just to guess the extension by checking common variants. ("", "html", "htm") one by one

[bjones1]

Good points, especially about asking the user for what we can get or guess in code. Let me ponder a bit on how best to do this.

[bjones1]

Andrei,

I've finished up all the fixes and changes I know -- would you take another look at this?

Thanks!

Bryan

[andreikop]

Cool job. Works fine for me. Was near to merge, but discovered some test failures. http://pastebin.com/m4D63qkq I use Linux, sphinx 1.1.3, CodeChat 0.0.16

I see, that one of the test is marked as expected failure. unittest.skip it to have cleaner log.

[bjones1]

Oops, I forgot to update CodeChat -- I was using the development version, which fixes the test failures. CodeChat is now at 0.0.17 -- please pip install CodeChat -U on your system.

Changed from expectedFailure to skip in 5c51d22b791d675d899230669ff7b9967aa673c3.

[andreikop]

Thanks. Will be released with the next version!

[bjones1]

Great! I'm really excited to have this functionality as a core part of Enki.