-
Notifications
You must be signed in to change notification settings - Fork 14
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Apply autosummary for module but not nested classes #19
Comments
Hi piyushk! Unfortunately, no, not yet. I see that this feature can be useful and it would be good to implement it! It should not be too difficult. Do you have any time that you can invest into this? I can work on it, but probably not much during the next four weeks since I am finishing my PhD. I am happy to discuss and review any new implementation. |
I'll take a look at it tomorrow. I haven't looked at the code in detail yet -- any quick pointers on how to implement the feature would be appreciated, but not necessary. |
I managed to find some time right now to look at this issue. I have opened a draft PR for this issue #20 which attempts a fix. We can continue discussion there. I'm unsure if my solution is correct, as I do not have familiarity with sphinx or autodoc code. We can also follow up at a later date when you're more available. I'm currently using my branch, so I'm not blocked. |
Closes Chilipp#19 - Add new option `autosummary-no-nesting` - New parameter allows for non-nested generation of autosummary tables. - Docs and tests for new feature.
I'm using autodocsumm along with sphinx-apidoc to generate documentation.
My current usage is as follows:
This creates the summary table as desired for the module, but also causes each class etc. in the package added by automodule to have a summary table, which is not desired. Is there an easy way I can get just the summary table for the module, and not for nested structures?
The text was updated successfully, but these errors were encountered: