On Tue, Nov 14, 2017, 6:01 AM johan Borgström <[email protected]> wrote:

> Hi,
>
> I am testing Sphinx and the autodoc feature. It seems like no
> documentation is generated when a class is extending a mocked module. (In
> my conf.py i am using autodoc_mock_imports = ['pymel', 'pyside2'])
>
> Does anyone have any tips for generating docs for mocked modules?
>

I've seen the same behaviour when I mock objects, but I usually do that
because they aren't available during the doc gen process and they aren't
objects I would want included in my docs anyways.
I'm curious, what kind of objects would you need to mock but also want to
document? If they are mocked it implies they aren't available, which means
neither are the docstrings or signatures of those objects.


> Best,
> Johan
>
> --
> You received this message because you are subscribed to the Google Groups
> "Python Programming for Autodesk Maya" group.
> To unsubscribe from this group and stop receiving emails from it, send an
> email to [email protected].
> To view this discussion on the web visit
> https://groups.google.com/d/msgid/python_inside_maya/fea21276-740f-4a55-849b-c9ec1efcd222%40googlegroups.com
> <https://groups.google.com/d/msgid/python_inside_maya/fea21276-740f-4a55-849b-c9ec1efcd222%40googlegroups.com?utm_medium=email&utm_source=footer>
> .
> For more options, visit https://groups.google.com/d/optout.
>

-- 
You received this message because you are subscribed to the Google Groups 
"Python Programming for Autodesk Maya" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to [email protected].
To view this discussion on the web visit 
https://groups.google.com/d/msgid/python_inside_maya/CAPGFgA1zQret_cHCGVEEJrtMs9EVuBnnYdW3rBjdVkF8D1mBXA%40mail.gmail.com.
For more options, visit https://groups.google.com/d/optout.

Reply via email to