Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP

Loading…

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

Open
SimonSapin opened this Issue · 5 comments

3 participants

Simon Sapin Markus Unterwaditzer Ian Cordasco
Simon Sapin

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:
Markus Unterwaditzer
Collaborator

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.

Ian Cordasco

@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

Markus Unterwaditzer
Collaborator

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.

Markus Unterwaditzer
Collaborator

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.

Markus Unterwaditzer
Collaborator

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Something went wrong with that request. Please try again.