Hi Joshua,

Thank you for reporting. I believe it should be improved. Could you
file an issue to GitHub, please?
Then I'll work on it.

Thanks,
Takeshi KOMIYA

2020年8月12日(水) 9:34 Joshua J. Kugler <jos...@azariah.com>:
>
> On Monday, August 10, 2020 12:54:59 PM AKDT Joshua Kugler wrote:
> > I have an oddity here. I have a Python project for which I've generated
> > docs. It did well. Almost everything was doc'ed. I know about the default
> > of excluding anything starting with '_' so I created an autodoc-skip-member
> > function that would include those. It works. I see a bunch of private
> > methods and functions included. But...I have a module, let's call it XYZ
> > that has both private and public functions. Sphinx is only doc'ing the
> > public functions of XYZ, but not its private functions. I have other
> > modules that have private functions, and it's doc'ing those.
> >
> > I added a print() to the autodoc-skip-member function and it doesn't even
> > print out the `name` of those private functions so it seems it's not even
> > seeing it.
>
> So, I figured this out. The file concerned had an __all__ statement. So, on 
> one
> hand, I understand the reason it was being excluded, but on the other hand,
> why does __all__ prevent passing the identifiers the autodoc-skip-member
> function?
>
> That said, this is probably doc'ed somewhere, eh?  Anybody got a pointer? :)
>
> j
>
> --
> Joshua J. Kugler - Fairbanks, Alaska - jos...@azariah.com
> Azariah Enterprises - Programming and Website Design
> PGP Key: http://pgp.mit.edu/  ID 0x68108cbb73b13b6a
>
>
> --
> 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/25359779.uLBTZSqOf5%40hosanna.

-- 
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/CAFmkQAO8g046c5fikZLYPcRWZqDUv1q%3DP6J7Z5gVzDfRntwb%2BQ%40mail.gmail.com.

Reply via email to