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

Enable sphinx doc building in daf_butler

    Details

    • Story Points:
      2
    • Sprint:
      BG3_S18_02, BG3_S18_03
    • Team:
      Architecture

      Description

      Turn on building of sphinx documentation. We already use numpydoc for docstrings but some may need tidying as a result of the documentation actually being built.

        Attachments

          Activity

          Hide
          tjenness Tim Jenness added a comment -

          This is ready for review. Major clean ups to docstrings were required. There are issues with Quantum and Dataset not working right but we can worry about those later I think. Merging this quickly will make it easy for people who are working on feature branches.

          Show
          tjenness Tim Jenness added a comment - This is ready for review. Major clean ups to docstrings were required. There are issues with Quantum and Dataset not working right but we can worry about those later I think. Merging this quickly will make it easy for people who are working on feature branches.
          Hide
          pschella Pim Schellart [X] (Inactive) added a comment -

          Looks good. Minor changes on PR.

          Show
          pschella Pim Schellart [X] (Inactive) added a comment - Looks good. Minor changes on PR.
          Hide
          jbosch Jim Bosch added a comment -

          I took a very superficial look (mostly to see what kinds of changes were necessary), and didn't see anything I hated.  As long as someone else has taken a more careful look (it seems that Pim Schellart [X] has), I approve.

          Show
          jbosch Jim Bosch added a comment - I took a very superficial look (mostly to see what kinds of changes were necessary), and didn't see anything I hated.  As long as someone else has taken a more careful look (it seems that Pim Schellart [X] has), I approve.
          Hide
          tjenness Tim Jenness added a comment -

          Merged. There are still some issues with the doc build but we can fix those as we go.

          Show
          tjenness Tim Jenness added a comment - Merged. There are still some issues with the doc build but we can fix those as we go.
          Hide
          jsick Jonathan Sick added a comment -

          Tim Jenness Is it still useful for me to comment/advise on the PR?

          Show
          jsick Jonathan Sick added a comment - Tim Jenness Is it still useful for me to comment/advise on the PR?

            People

            • Assignee:
              tjenness Tim Jenness
              Reporter:
              tjenness Tim Jenness
              Reviewers:
              Jim Bosch, Jonathan Sick, Pim Schellart [X] (Inactive)
              Watchers:
              Jim Bosch, Jonathan Sick, Pim Schellart [X] (Inactive), Tim Jenness
            • Votes:
              0 Vote for this issue
              Watchers:
              4 Start watching this issue

              Dates

              • Created:
                Updated:
                Resolved:

                Summary Panel