You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Sphinx autodoc doesn't manage to generate docstrings for any CachedClassProps, presumably because it just gets those attributes from the class, which get returned as the cached value.
This means things like TierBase.name_part_template are missing from the docs - they're important!
A solution may be found add some sort of preprocessor or whatever to Sphinx:
and it seems the wraps is passing on the correct docstring. So it should be possible to generate the docstring I think, provided we can find a way to get the right object to Sphinx.
The text was updated successfully, but these errors were encountered:
The accessors continue to cause chaos.
Sphinx autodoc doesn't manage to generate docstrings for any CachedClassProps, presumably because it just gets those attributes from the class, which get returned as the cached value.
This means things like
TierBase.name_part_template
are missing from the docs - they're important!A solution may be found add some sort of preprocessor or whatever to Sphinx:
https://www.sphinx-doc.org/en/master/usage/extensions/autodoc.html#event-autodoc-process-docstring
The CachedClassProps can be fetch from the classes using the syntax (which bypasses the accessor protocol):
and it seems the wraps is passing on the correct docstring. So it should be possible to generate the docstring I think, provided we can find a way to get the right object to Sphinx.
The text was updated successfully, but these errors were encountered: