Skip to content
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

Update class.rst #2143

Draft
wants to merge 7 commits into
base: master
Choose a base branch
from
Draft

Update class.rst #2143

wants to merge 7 commits into from

Conversation

ydcjeff
Copy link
Contributor

@ydcjeff ydcjeff commented Aug 6, 2021

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)

@github-actions github-actions bot added the docs label Aug 6, 2021
@ydcjeff
Copy link
Contributor Author

ydcjeff commented Aug 6, 2021

Turns out that inherited members are not shown if we use .. automodule::.

@vfdev-5
Copy link
Collaborator

vfdev-5 commented Aug 6, 2021

@ydcjeff
Copy link
Contributor Author

ydcjeff commented Aug 6, 2021

@vfdev-5
Copy link
Collaborator

vfdev-5 commented Aug 6, 2021

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 ?

@ydcjeff
Copy link
Contributor Author

ydcjeff commented Aug 6, 2021

I think because

@vfdev-5 vfdev-5 marked this pull request as draft August 20, 2021 13:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants