You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@beam.apache.org by "Kenneth Knowles (Jira)" <ji...@apache.org> on 2022/06/03 16:39:00 UTC

[jira] [Commented] (BEAM-1756) Annotate code references inside inline documentation in Python-SDK

    [ https://issues.apache.org/jira/browse/BEAM-1756?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17546351#comment-17546351 ] 

Kenneth Knowles commented on BEAM-1756:
---------------------------------------

This issue has been migrated to https://github.com/apache/beam/issues/18232

> 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: P3
>              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
(v8.20.7#820007)