apache/beam
Annotate code references inside inline documentation in Python-SDK
開放
#18,232 建立於 2022年6月3日
P3coregood first issueimprovementpython
倉庫指標
- 星標
- (7,313 顆星)
- PR 合併指標
- (PR 指標待抓取)
描述
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
Imported from Jira BEAM-1756. Original Jira may contain additional context. Reported by: tibor.kiss@gmail.com.