Catch exceptions in the only handling

[pietvr]

Give rst line and file information upon exceptions in sphinx_selective_exclude

Example syntax error:

.. someItem

.. only:: whenSomethingEnabled
       someItemSometime

With this fix the exception info:

/home/dev/mysphynx/index.rst:15: WARNING: exception while evaluating 'only' directive expression: chunk after expression  

Fixes #6

[SteinHeselmans]

this should be a global variable of the file, or a class-member, or property or whatever. Having it here in the except only, will force new logs to copy this line around...

[pfalcon]

this should be a global variable

+1. And please initialize it as logger = sphinx.util.logging.getLogger(__name__) to avoid confusion of what it is.

[pietvr]

I have done this now.

Sorry I missed this comment.

[SteinHeselmans]

are we sure we just want to log a warning and continue building? There probably wont be any html/latex generated for this directive due to this syntax error. And not every rst-write cares too much about terminal warnings. Two suggestions:

• or 1, we still fail the sphinx-build but give more details on where the syntax error is located
• or 2, we add some warning in the generated html/latex as well stating there was a syntax error,

for option 1, we could derive a specific Exception class where we added more details. For an example see https://github.com/melexis/sphinx-traceability-extension/blob/master/mlx/traceability_exception.py#L38-L60

[pietvr]

Stein,

I intended to raise. So I corrected this already.

For this exception class. I do not know whether there is much added value at this point.
This sphinx_selective_exclude is only 1 file so it is still clean like it is added now.

Usually I add this class the second time I add the same code.

Piet

[pfalcon]

"exception while evaluating ... expression" looks like an logger.error() to me, not logger.warning(). Extra confirmed by the fact that you raise after it (so it's treated as kinda-fatal, which is not ideal, but ok).

[pietvr]

Hello @pfalcon,

Can you merge this one?
It improves to syntax error handling of the sphinx_selective_exclude.

Regards,
Piet,

[pfalcon]

This should be "exception while evaluating 'only' directive expression", otherwise it's confusing. Parens around message are superfluous.

[pietvr]

I've done this

[pfalcon]

Sorry, I'm too busy with the real life currently, and preparing for travel, so won't be able to look into this in detail (at least) until 2nd half of November.

In the meantime, a few suggestion based on a quick look. Please squash any fixes into the original commit. Also, if you didn't yet do that, please do "git log" and follow the same format for the commit message.

Also, can you please add an example of erroneous syntax and corresponding error message generated with this patch?

Thanks!