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

Docs do not show base classes #41

Open
erastorgueva-nv opened this issue Dec 14, 2023 · 1 comment
Open

Docs do not show base classes #41

erastorgueva-nv opened this issue Dec 14, 2023 · 1 comment

Comments

@erastorgueva-nv
Copy link
Collaborator

I just noticed that our docs do not show inheritance, though src/conf.py has 'show-inheritance': True. Would be nice to fix. So that we can see if the class inherits from BaseParallelProcessor or directly from BaseProcessor.

cc @Kipok, @karpnv
Screenshot 2023-12-14 at 12 33 17

@Kipok
Copy link
Collaborator

Kipok commented Dec 14, 2023

If you want to do that, just add directly :show-inheritance: to those classes in the rst file. Note how it's done at the end for the base classes - they do show inheritance. When I was originally writing that doc, I decided that showing base classes would complicate things as I was mostly thinking of that page as a "config-level" guide for users. That is, for people who are just building new configs based on the existing processors, it can be very useful to see all processors and their parameters, but they don't really need to know inheritance or see all the methods of those classes.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants