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

Let package-docs CLI auto-discover the doc directory

    XMLWordPrintable

Details

    Description

      The package-docs CLI requires a --dir argument to define the root doc/ directory. The default is the current working directory. It would be nice if the command could "discover" that doc/ directory if the current working directory is anywhere inside a package. This would greatly improve the usability of the package-docs CLI.

      Something similar can also be done for the stack-docs CLI, though in that case the goal is to find the conf.py file at the root of the pipelines_lsst_io repository.

      Attachments

        Activity

          jsick Jonathan Sick created issue -
          jsick Jonathan Sick made changes -
          Field Original Value New Value
          Epic Link DM-12790 [ 36408 ]
          jsick Jonathan Sick made changes -
          Risk Score 0
          jsick Jonathan Sick made changes -
          Status To Do [ 10001 ] In Progress [ 3 ]
          jsick Jonathan Sick made changes -
          Story Points 0.7
          jsick Jonathan Sick made changes -
          Story Points 0.7 1.3
          jsick Jonathan Sick made changes -
          Resolution Done [ 10000 ]
          Status In Progress [ 3 ] Done [ 10002 ]

          People

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

            Dates

              Created:
              Updated:
              Resolved:

              Jenkins

                No builds found.