Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Annotate code references inside inline documentation in Python-SDK #18232

Open
kennknowles opened this issue Jun 3, 2022 · 0 comments
Open

Annotate code references inside inline documentation in Python-SDK #18232

kennknowles opened this issue Jun 3, 2022 · 0 comments
Labels
core good first issue improvement P3 python

Comments

@kennknowles
Copy link
Member

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.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
core good first issue improvement P3 python
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@kennknowles @damccorm