You're looking for special-members.

https://www.sphinx-doc.org/en/master/usage/extensions/autodoc.html#directive-option-automodule-special-members


On Monday, 6 February 2023 at 01:58:03 UTC arequ...@gmail.com wrote:

> Is is possible to generate documentation for for private (double
> underscore) class members?
>
> I have tried passing the -P option to sphinx-apidoc, and I have also set
> autodoc_default_options in my conf.py:
>
> autodoc_default_options = {
> 'members': True,
> 'undoc-members': True,
> 'private-members': True
> }
>
> In both cases, class members whose names begin with two underscores are
> not included in the generated documentation.
>
> Is it possible to do this?
>
> Thanks!
>
> -- 
> ========================================================================
> Google Where SkyNet meets Idiocracy
> ========================================================================
>

-- 
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/60e192cd-59fe-4d45-947e-69ae05c0e132n%40googlegroups.com.

Reply via email to