So the reST document is literally:
.. currentmodule:: my_module
Standard API
============
MySection
---------
.. autosummary::
TopClass
TopClass
~~~~~~~~~
.. autoclass:: TopClass
:members:
On Wed, Mar 30, 2022 at 6:14 PM Komiya Takeshi <i.tkom...@gmail.com> wrote:
> Hi,
>
> What option do you pass to the autodoc directives? Please show an
> example of reST document.
>
> Thanks,
> Takeshi KOMIYA
>
> 2022年3月30日(水) 18:26 'Alex Botev' via sphinx-users
> <sphinx-users@googlegroups.com>:
> >
> > So I have something among the lines of:
> >
> > ```
> > class TopClass:
> > @my_decorator
> > class InternalClass:
> > """Persistent state."""
> > a: int
> > b: int
> > c: int
> > ```
> > Running autodoc correctly picks up InternalClass, but I get a lot of its
> private members documented, e.g.:
> > __dataclass_params__=
> _DataclassParams(init=True,repr=True,eq=True,order=False,unsafe_hash=False,
> frozen=False) __dict__= mappingproxy({'__module__': 'my_module.try',
> '__annotations__': {'a': 'int', 'b': 'int', 'c': 'int'}, '__doc__':
> 'Persistent state.', '__dict__': <attribute '__dict__' of 'InternalClass'
> objects>, '__weakref__': <attribute '__weakref__' of 'State' objects>,
> '__dataclass_params__':
> _DataclassParams(init=True,repr=True,eq=True,order=False,unsafe_hash=False,frozen=False),
> '__dataclass_fields__': {'a':
> Field(name='a',type='int',default=<dataclasses._MISSING_TYPE
> object>,default_factory=<dataclasses._MISSING_TYPE
> object>,init=True,repr=True,hash=None,compare=True,metadata=mappingproxy({}),_field_type=_FIELD),
> 'b': Field(name='b',type='int',default=<dataclasses._MISSING_TYPE
> object>,default_factory=<dataclasses._MISSING_TYPE
> object>,init=True,repr=True,hash=None,compare=True,metadata=mappingproxy({}),_field_type=_FIELD),
> 'c': Field(name='c',type='int',default=<dataclasses._MISSING_TYPE
> object>,default_factory=<dataclasses._MISSING_TYPE
> object>,init=True,repr=True,hash=None,compare=True,metadata=mappingproxy({}),_field_type=_FIELD)},
> '__init__': <function __create_fn__.<locals>.__init__>, '__repr__':
> <function __create_fn__.<locals>.__repr__>, '__eq__': <function
> __create_fn__.<locals>.__eq__>, '__hash__': None}) __eq__(other) Return
> self==value. __hash__= None __init__(a, b, c)
> >
> > How can I prevent this?
> >
> > --
> > You received this message because you are subscribed to the Google
> Groups "sphinx-users" group.
> > To unsubscribe from this group and stop receiving emails from it, send
> an email to sphinx-users+unsubscr...@googlegroups.com.
> > To view this discussion on the web visit
> https://groups.google.com/d/msgid/sphinx-users/2451dc5a-f3d8-43e0-a197-dc6afa8a34d9n%40googlegroups.com
> .
>
> --
> You received this message because you are subscribed to the Google Groups
> "sphinx-users" group.
> To unsubscribe from this group and stop receiving emails from it, send an
> email to sphinx-users+unsubscr...@googlegroups.com.
> To view this discussion on the web visit
> https://groups.google.com/d/msgid/sphinx-users/CAFmkQANagzJDJZajUueXd8hPugpGMNEV2P0yXxExjfwXKz1w0A%40mail.gmail.com
> .
>
--
You received this message because you are subscribed to the Google Groups
"sphinx-users" group.
To unsubscribe from this group and stop receiving emails from it, send an email
to sphinx-users+unsubscr...@googlegroups.com.
To view this discussion on the web visit
https://groups.google.com/d/msgid/sphinx-users/CAPjNthsR_i9bi_dhe_q-AYOU4Gs8GfEjRNknASEFT_mM-O0Gsw%40mail.gmail.com.
