[
https://issues.apache.org/jira/browse/BEAM-1756?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
]
Ismaël Mejía updated BEAM-1756:
-------------------------------
Status: Open (was: Triage Needed)
> Annotate code references inside inline documentation in Python-SDK
> ------------------------------------------------------------------
>
> Key: BEAM-1756
> URL: https://issues.apache.org/jira/browse/BEAM-1756
> Project: Beam
> Issue Type: Improvement
> Components: sdk-py-core
> Reporter: Tibor Kiss
> Priority: Minor
> Labels: newbie, starter
>
> 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
--
This message was sent by Atlassian JIRA
(v7.6.3#76005)
