ID 323246 - Katana Developer Guide: internal members of Python classes exposed in Sphinx-generated developer documentation

Follow

Problem summary:

The Katana Developer Guide that's generated using Sphinx includes some pseudo-private members of certain classes that make the documentation harder to read/parse, obfuscating the documentation.

Steps to reproduce:

  1. Open the documentatiion for NodeTypeBuilder in a web browser:
    • https://learn.foundry.com/katana/dev-guide/Scripting/CustomizingNodeTypes/CustomNodeTypes/NodeTypeBuilder.html
  2. Open the documentation for Imath Python bindings in a web browser:
    • https://learn.foundry.com/katana/dev-guide/OpsAndOpScript/Imath/Python.html
  3. Note the presence of various pseudo-private special members like the following:
    • 
      __dict____module____weakref____iter____getitem____getslice____eq____ne____len____repr____str__

Expected behaviour:

Internal members other than __init__ should not be included in developer documentation.

Actual behaviour:

All internal members are included in developer documentation.

Workaround:

No known workaround.

Customer version/platform:

Katana 2.6v3/Linux

    We're sorry to hear that

    Please tell us why