apache/beam
GitHub で見るAnnotate code references inside inline documentation in Python-SDK
Open
#18,232 opened on 2022年6月3日
P3coregood first issueimprovementpython
Repository metrics
- Stars
- (7,313 stars)
- PR merge metrics
- (平均マージ 6d) (30d で 243 merged PRs)
説明
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.