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

add sphinx documentation of the Click CLI in daf_butler

    XMLWordPrintable

    Details

    • Story Points:
      4
    • Epic Link:
    • Sprint:
      DB_F20_09
    • Team:
      Data Access and Database
    • Urgent?:
      No

      Attachments

        Issue Links

        relates to

        Story - Created by Jira Software - do not edit or delete. Issue type for a user story. DM-24398 Add Click documentation to the developer guide

        • Done

        Story - Created by Jira Software - do not edit or delete. Issue type for a user story. DM-21898 Create command-line tools for Gen3 repo administration

        • Won't Fix
        mentioned in

        Page Loading...

          Activity

          Ascending order - Click to sort in descending order
          No builds found.
          npease Nate Pease [X] (Inactive) created issue -
          npease Nate Pease [X] (Inactive) made changes -
          Field Original Value New Value
          Status To Do [ 10001 ] In Progress [ 3 ]
          npease Nate Pease [X] (Inactive) made changes -
          Epic Link DM-22400 [ 427076 ]
          npease Nate Pease [X] (Inactive) made changes -
          Component/s daf_butler [ 11300 ]
          Labels gen2-deprecation-blocker gen3-middleware
          npease Nate Pease [X] (Inactive) made changes -
          Link This issue relates to DM-21898 [ DM-21898 ]
          Hide
          Permalink
          jsick Jonathan Sick added a comment -

          In DM-24411 I've added the sphinx-click to the default configuration for stack documentation projects. This means you won't need to add sphinx_click in your own conf.py file. It also means that these docs can be built by Jenkins (e.g. daily documentation builds, weekly builds, etc.).

          Show
          jsick Jonathan Sick added a comment - In DM-24411 I've added the sphinx-click to the default configuration for stack documentation projects. This means you won't need to add sphinx_click in your own conf.py file. It also means that these docs can be built by Jenkins (e.g. daily documentation builds, weekly builds, etc.).
          npease Nate Pease [X] (Inactive) made changes -
          Resolution Done [ 10000 ]
          Status In Progress [ 3 ] Done [ 10002 ]
          npease Nate Pease [X] (Inactive) made changes -
          Resolution Done [ 10000 ]
          Status Done [ 10002 ] To Do [ 10001 ]
          npease Nate Pease [X] (Inactive) made changes -
          Status To Do [ 10001 ] In Progress [ 3 ]
          tjenness Tim Jenness made changes -
          Link This issue relates to DM-24398 [ DM-24398 ]
          fritzm Fritz Mueller made changes -
          Sprint DB_S20_02 [ 1003 ] DB_S20_02, DB_F20_06 [ 1003, 1026 ]
          fritzm Fritz Mueller made changes -
          Epic Link DM-22400 [ 427076 ] DM-25244 [ 435560 ]
          Hide
          Permalink
          npease Nate Pease [X] (Inactive) added a comment -

          Ignore the dm_dev_guide branch; it will not get checked in with this ticket.

          Show
          npease Nate Pease [X] (Inactive) added a comment - Ignore the dm_dev_guide branch; it will not get checked in with this ticket.
          Hide
          Permalink
          npease Nate Pease [X] (Inactive) added a comment -

          Hi Michelle, thanks for agreeing to review.

          Show
          npease Nate Pease [X] (Inactive) added a comment - Hi Michelle, thanks for agreeing to review.
          npease Nate Pease [X] (Inactive) made changes -
          Reviewers Michelle Gower [ mgower ]
          Status In Progress [ 3 ] In Review [ 10004 ]
          Hide
          Permalink
          mgower Michelle Gower added a comment -

          Some typos to fix. Merge is approved.

          An organization question about generic click framework code being in daf_butler instead of a more generic package.

          The documentation will help with writing subcommands for butler/pipetask.

          The code/option reuse is nice. For future discussion, not sure how to take advantage of this if using YAML config files instead of command line arguments.

          Show
          mgower Michelle Gower added a comment - Some typos to fix. Merge is approved. An organization question about generic click framework code being in daf_butler instead of a more generic package. The documentation will help with writing subcommands for butler/pipetask. The code/option reuse is nice. For future discussion, not sure how to take advantage of this if using YAML config files instead of command line arguments.
          mgower Michelle Gower made changes -
          Status In Review [ 10004 ] Reviewed [ 10101 ]
          fritzm Fritz Mueller made changes -
          Sprint DB_S20_02, DB_F20_06 [ 1003, 1026 ] DB_F20_09 [ 1048 ]
          gruendl Robert Gruendl [X] (Inactive) made changes -
          Remote Link This issue links to "Page (Confluence)" [ 25789 ]
          npease Nate Pease [X] (Inactive) made changes -
          Resolution Done [ 10000 ]
          Status Reviewed [ 10101 ] Done [ 10002 ]

            People

            Assignee:
            npease Nate Pease [X] (Inactive)
            Reporter:
            npease Nate Pease [X] (Inactive)
            Reviewers:
            Michelle Gower
            Watchers:
            Jonathan Sick, Michelle Gower, Nate Pease [X] (Inactive)
            Votes:
            0 Vote for this issue
            Watchers:
            3 Start watching this issue

              Dates

              Created:
              Updated:
              Resolved:

                Jenkins

                No builds found.