Overriding Sphinx autodoc “Alias of” for import of private class?

前端 未结 2 803
春和景丽
春和景丽 2021-02-18 22:46

I have a Python package that I am attempting to document with sphinx-autodoc. My python package has an __init__.py file that imports a class out from a submodule to

2条回答
  •  星月不相逢
    2021-02-18 23:21

    Sphinx uses the __name__ and __module__ members of the class, and the __module__ member of the owner of the class to figure out if it is an alias or the real thing. You can trick Sphinx in thinking that your imported class is the real one by setting these members explicitly.

    from a.b.c.d import _Foo as Foo
    Foo.__module__ = __name__
    Foo.__name__ = 'Foo'
    

提交回复
热议问题