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

:inherited-members: does not work for attributes #480

Closed
SimonSapin opened this issue Apr 9, 2012 · 6 comments · Fixed by #2363
Closed

:inherited-members: does not work for attributes #480

SimonSapin opened this issue Apr 9, 2012 · 6 comments · Fixed by #2363
Labels

Comments

@SimonSapin
Copy link
Contributor

I am not sure if this is a bug in Sphinx, but stuff like the root_path and static_url_path attributes/properties from _PackageBoundObject end up not documented in the API page of the docs. api.rst just contains this:

.. autoclass:: Flask
   :members:
   :inherited-members:
@untitaker
Copy link
Contributor

I am not sure what you mean. The rst docs shouldn't contain any information, they have to be compiled with sphinx to be actually helpful.

@sigmavirus24
Copy link

@SimonSapin is correct: In the docs, root_path and static_url_path don't appear.

The former should be there but I don't see it anywhere, the latter shouldn't be because it isn't properly documented in the class. This should ensure that the former be included since that one is properly documented. The latter can probably be covered by adding documentation here or here

@untitaker
Copy link
Contributor

root_path is not documented in a way Sphinx can find it, i think. The #:-comment with the variable declaration is inside the __init__ method of _PackageBoundObject, not at the same level the methods are defined.

@untitaker
Copy link
Contributor

I just tried to add a new attribute to _PackageBoundObject and it seemed that Sphinx just ignored it. When adding the same to Flask, it works. Maybe something in conf.py that prevents Sphinx from documenting inherited members.

@untitaker
Copy link
Contributor

I filed an issue about this in sphinx' bugtracker, since it occured to me in a completely unrelated project.

@jeffwidman
Copy link
Contributor

Sphinx moved their issue tracker to GitHub and marked the above linked issue as a duplicate, so the new link to the upstream issue is sphinx-doc/sphinx#741

@davidism davidism added the docs label Jun 1, 2017
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Nov 14, 2020
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Projects
None yet
Development

Successfully merging a pull request may close this issue.

5 participants