Uploaded image for project: 'Data Management'
  1. Data Management
  2. DM-17063

Label asyncio coroutines in Sphinx Python API reference documentation

    Details

    • Type: Story
    • Status: To Do
    • Resolution: Unresolved
    • Fix Version/s: None
    • Component/s: documenteer
    • Labels:
      None

      Description

      The Python language docs label coroutine APIs in the reference documentation. This capability would be useful for LSST as well (both for T&S and SQuaRE). Coroutine labelling isn't part of Sphinx yet (see PR 1826 which is stalled, unfortunately), but the cpython project does have a pyspecific Sphinx extension that provides callbacks to autodoc that add coroutine labelling. We can port this extension into Documenteer for LSST use.

      See https://stackoverflow.com/questions/36403655/documenting-python-coroutines-with-sphinx-autodoc for discussion.

        Attachments

          Container Issues

            Activity

              People

              • Assignee:
                jsick Jonathan Sick
                Reporter:
                jsick Jonathan Sick
                Watchers:
                Jonathan Sick, Russell Owen
              • Votes:
                0 Vote for this issue
                Watchers:
                2 Start watching this issue

                Dates

                • Created:
                  Updated:

                  Summary Panel