beam-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Tibor Kiss (JIRA)" <j...@apache.org>
Subject [jira] [Commented] (BEAM-1756) Annotate code references inside inline documentation in Python-SDK
Date Mon, 20 Mar 2017 08:43:41 GMT

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

Tibor Kiss commented on BEAM-1756:
----------------------------------

FYI: [~sb2nov] / [~altay]

> 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: Bug
>          Components: sdk-py
>            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
(v6.3.15#6346)

Mime
View raw message