Sphinx fails when encountering broken properties

Thomas Lotze avatarThomas Lotze created an issue

If a property raises an AttributeError when Sphinx tries to read its value, Sphinx fails. Such cases should be handled more gracefully.

The technical solution probably involves replacing inspect.getmembers() by something self-made. I'm not sure what the best behaviour would be, though. I think the rest of the class in question should be properly documented, but I can think of several options for how to handle the broken property: skip them in the output, include them but without any docs, print a marked-up warning, ...

Comments (1)

  1. Log in to comment
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.