This repository was archived by the owner on Nov 11, 2024. It is now read-only.
Repository navigation
This repository was archived by the owner on Nov 11, 2024. It is now read-only.
smart_resolver isn't working for descriptor classes #28
Description
For classes such as ConfigItem, which use the InheritDocstrings meta-class, the following code in smart_resolver doesn't work:
if what in ('class', 'exception'):
because what ends up being attribute for those classes. I haven't figured out why yet, but it seems to be to do with the fact that type(ConfigItem) is not type.
Activity
astrofrog commentedon Jun 1, 2014
@mdboom - any ideas how to get around this issue?
mdboom commentedon Jun 1, 2014
Can you provide an example of a link that fails?
astrofrog commentedon Jun 2, 2014
The easiest way to see the warning I've been seeing is to check out the branch from astropy/astropy#2508, and remove the three astropy.config classes from the
docs/nitpick-exceptionsfile, then runpython setup.py build_sphinx.mdboom commentedon Jun 2, 2014
The
InheritDocstringsis a red herring, and indeed this works for other classes withInheritDocstrings. What this doesn't work for is for descriptor classes, which Sphinx considers to be something different than regular classes. Fix is attached (and @astrofrog: would you mind editing the title of this issue so we can find it later?)[-]smart_resolver isn't working for classes that use InheritDocstrings[/-][+]smart_resolver isn't working for descriptor classes[/+]