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

Generate summaries of tasks' Python APIs for task documentation topics

    Details

      Description

      For the Sphinx-based task topic documentation, we want to be able to show the signature of the task's Python API (particularly its _init_ and run methods). This shouldn't replace the canonical source of documentation as generated by automodapi, but it should instead give users a quick summary and entrypoint into that API documentation.

      One scenario is to show the signatures of the tasks's constructor and methods, and make those signatures clickable so that a user can access the API docs quickly.

      Another approach might be to also show the full docstring of things like the constructor and run method.

      The best approach is TBD.

        Attachments

          Issue Links

            Activity

              People

              • Assignee:
                jsick Jonathan Sick
                Reporter:
                jsick Jonathan Sick
                Watchers:
                Jonathan Sick
              • Votes:
                0 Vote for this issue
                Watchers:
                1 Start watching this issue

                Dates

                • Created:
                  Updated:
                  Resolved:

                  Summary Panel