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

Generated docs include super class' methods #48

Open
ki4070ma opened this issue Sep 28, 2019 · 2 comments
Open

Generated docs include super class' methods #48

ki4070ma opened this issue Sep 28, 2019 · 2 comments
Labels
enhancement New feature or request

Comments

@ki4070ma
Copy link

ki4070ma commented Sep 28, 2019

Problem

Generated docs include super class' methods.

methods

Expected results

Generated docs include methods only for the target class.

https://github.com/ki4070ma/python-client/blob/master/appium/webdriver/extensions/device_time.py

  • device_time
  • get_device_time

Used portray version

1.3.1

Generated docs

https://ki4070ma.github.io/python-client/reference/appium/webdriver/extensions/device_time/

@kootenpv
Copy link

I agree - I would like an option to prevent creating documentation for super level too.

In my case, I inherit from a pandas DataFrame and that leads to way too much documentation.

@timothycrosley timothycrosley added the enhancement New feature or request label Aug 27, 2020
@rachel-1
Copy link

Is this a planned feature? It looks like this functionality is now available in the original pdoc repo: mitmproxy/pdoc#15 (comment). In fact, the pdoc repo is now actively maintained and has an example for running with mkdocs...I like portray for its simplicity, but I'm working with code that subclasses Pytorch's nn.module so the inability to hide the huge list of methods from the parent class would be a deal-breaker.

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

No branches or pull requests

4 participants