-
Notifications
You must be signed in to change notification settings - Fork 131
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
Remove Attributes + classes show no description #443
Comments
For (1), this page outlines how you can customise what gets documented: https://sphinx-autoapi.readthedocs.io/en/latest/how_to.html#how-to-customise-what-gets-documented For (2), it'll require some more investigation. It looks to be something going wrong in the autosummary directive because the class itself has the docstring. Maybe the fact that it's a dataclass is what's triggering the bug. Thanks for providing a way to reproduce the issue. |
Thank you @AWhetter. I explained myself poorly, what I want is for the listing of classes at the bottom of that page to not be there. Not only because it is repeated information, but also because it seems to introduce warnings such as:
that I don't know how to get rid of. Also, it confuses the links. For example, if you go to https://asteca.readthedocs.io/en/latest/autoapi/asteca/synthetic/index.html# and click on |
I see now that I can create my own API page and put whatever contents I want there, for example:
This solves the issue of |
My documentation can be found here https://asteca.readthedocs.io/en/latest/autoapi/asteca/index.html
I have two issues:
Can this be done? Thank you!
The text was updated successfully, but these errors were encountered: