sphinx-contrib / apidoc

A Sphinx extension for running sphinx-apidoc on each build
http://www.sphinx-doc.org/
BSD 2-Clause "Simplified" License
58 stars 12 forks source link

Cannot include private methods with apidoc_extra_args #14

Closed Dantali0n closed 4 years ago

Dantali0n commented 4 years ago

When I use apidoc_extra_args = ['-P'] the private methods starting with _ are still not included in the generated documentation. The same happens with --private.

stephenfin commented 4 years ago

Can you reproduce this with a direct call to sphinx-apidoc? I would assume so, since we're simply passing things through to that executable. If you can, I think you should report this against Sphinx itself. If not, can you please reopen this and provide debug-level logs.

Dantali0n commented 4 years ago

@stephenfin Can you provide details on how the logs you expect can be generated as it is not clearly listed in http://www.sphinx-doc.org/en/master/devguide.html

In addition I think it is important to note that I can not reopen this issue since you have closed it. The option is simply not available.

stephenfin commented 4 years ago

You'll want to use -v when calling sphinx-build, which can be specified multiple times. Before that though, can you check if this can be reproduced via a direct call to sphinx-apidoc?

I didn't know people couldn't reopen issues. That seems odd, but I can reopen if it turns out that this is an issue.

Dantali0n commented 4 years ago

Seems this issue occurs with native sphinx-apidoc, do you know how to submit bug reports for this project. It is hard to find the relevant developer documentation for sphinx stuff imo.

stephenfin commented 4 years ago

You'll want https://github.com/sphinx-doc/sphinx/issues