[BEAM-1756] Annotate code references inside inline documentation in Python-SDK

• Type: Improvement
• Status: Open
• Priority: P3
• Resolution: Unresolved
• Component/s: sdk-py-core
• Labels: newbie starter
• Assignee: Unassigned
• Reporter: Tibor Kiss
• Created: 20/Mar/17 08:41
• Updated: 03/Jun/22 16:38

Description

Some of the inline documentation in Python-SDK contains references to classes, methods or fields. The document generation tool (Sphinx) supports annotating such code blocks.

If the inline documentation is annotated properly then the references will be linked (clickable) on the generated site.

Relevant Sphinx documentation:
http://www.sphinx-doc.org/en/stable/markup/inline.html#xref-syntax