python warning when "print(__doc__)" about sphinx-gallery HOT 3 CLOSED

I can reproduce this. It seems this is __builtin__.__doc__ somehow making its way in the output of the script rather than the module __doc__, probably because of the way we exec the script.

Also I seem to remember that there was some code in the scikit-learn gen_rst.py to strip the module __doc__ from the script output since the reST docstring was already inside the html but I couldn't find it in sphinx-gallery.

from sphinx-gallery.

So this one is a bit tricky.
Now that we slice the script by blocks the docstring is just absent when running the script. So you get something from automatic generation.
I guess your use case is the reason for this
https://github.com/scikit-learn/scikit-learn/blob/master/doc/sphinxext/gen_rst.py#L867-L872
Which was unclear and unnecessary to me when refactoring.
My quick fix would be to change
https://github.com/sphinx-gallery/sphinx-gallery/blob/master/sphinxgallery/gen_rst.py#L478
into something like

example_globals = {'__doc__': ''}

I have not tested.
But this would be too specific to usecase

from sphinx-gallery.

+1 for globals trick

On 17 août 2015, at 15:44, Óscar Nájera [email protected] wrote:

So this one is a bit tricky.
Now that we slice the script by blocks the docstring is just absent when running the script. So you get something from automatic generation.
I guess your use case is the reason for this
https://github.com/scikit-learn/scikit-learn/blob/master/doc/sphinxext/gen_rst.py#L867-L872
Which was unclear and unnecessary to me when refactoring.
My quick fix would be to change
https://github.com/sphinx-gallery/sphinx-gallery/blob/master/sphinxgallery/gen_rst.py#L478
into something like

example_globals = {'doc': ''}
I have not tested.
But this would be too specific to usecase

—
Reply to this email directly or view it on GitHub.

from sphinx-gallery.