ignite
ignite copied to clipboard
Update class.rst
Fixes #{issue number}
Description:
Check list:
- [ ] New tests are added (if a new feature is added)
- [ ] New doc strings: description and/or example code are in RST format
- [ ] Documentation is updated (if required)
Turns out that inherited members are not shown if we use .. automodule::
.
I checked Accuracy and it shows inherited methods:
- https://deploy-preview-2143--pytorch-ignite-preview.netlify.app/generated/ignite.metrics.accuracy#ignite.metrics.Accuracy
But not in https://deploy-preview-2143--pytorch-ignite-preview.netlify.app/generated/ignite.contrib.handlers.tensorboard_logger.html#ignite.contrib.handlers.tensorboard_logger.TensorboardLogger
cuz that page is using .. automodule::
.
Accuracy is using .. autoclass::
Do we override automodule here: https://github.com/pytorch/ignite/blob/8148ce66329aaac14d0cc5dab8296878998f6115/docs/source/_templates/autosummary/module.rst ?
I do not understand the blocker, can give more details on why it does not work ?
I think because
- we are not using
:toctree: generated
like in handlers.rst underClasses
inmodule.rst
. - we are using
:members:
under.. automodule::
to show the members (classes or functions) of the given module and methods are considered members of the class so methods are not showing there.