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

Create a Sphinx directive that describes where a task is used

    XMLWordPrintable

Details

    Description

      Create a Sphinx directive that automatically discovered and lists the tasks that call a given task. This will be used in task documentation to provide two-way linking up and down the task call stack (the subtask listing provides linking down the call stack).

      I think there should be two types of links, treated slightly differently:

      • Call from regular Tasks should be direct parent-child relationship.
      • Any CmdLineTask that ultimately uses a task should be listed.

      Note that the language needs to be hedged as "default" users since subtask retargeting entirely changes the call pattern. This can't be documented with Sphinx until we build a dynamic task documentation app.

      Attachments

        Issue Links

          Activity

            tjenness Tim Jenness added a comment -

            This seems interesting still, although command line task is now gone.

            tjenness Tim Jenness added a comment - This seems interesting still, although command line task is now gone.

            I'll close this and re-open with a more relevant ticket when we're actively working on new task documentation features so that our "idea" backlog tickets don't get caught up in the CCB oversight.

            jsick Jonathan Sick added a comment - I'll close this and re-open with a more relevant ticket when we're actively working on new task documentation features so that our "idea" backlog tickets don't get caught up in the CCB oversight.

            People

              jsick Jonathan Sick
              jsick Jonathan Sick
              Jonathan Sick, Tim Jenness
              Votes:
              0 Vote for this issue
              Watchers:
              2 Start watching this issue

              Dates

                Created:
                Updated:
                Resolved:

                Jenkins

                  No builds found.