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

Enable Sphinx support for ip_diffim

    Details

      Description

      Enables Sphinx support by uncommenting `automodapi` and fixing the errors and warnings.

        Attachments

          Issue Links

            Activity

            Hide
            sullivan Ian Sullivan added a comment -

            I've cleaned up the namespace of `ip_diffim` by adding `_all_` to modules where it was missing, and Sphinx now builds with automodapi turned on. It does generate many warnings about the documentation formatting, but I believe those are best fixed when the docstrings are converted over to numpydoc.

            Show
            sullivan Ian Sullivan added a comment - I've cleaned up the namespace of `ip_diffim` by adding `_ all _` to modules where it was missing, and Sphinx now builds with automodapi turned on. It does generate many warnings about the documentation formatting, but I believe those are best fixed when the docstrings are converted over to numpydoc.
            Hide
            jsick Jonathan Sick added a comment -

            Looks good in principle. The only necessary change is fix up the location of _all_ to follow the Developer Guide.

            I assume you've checked that the additions of _all_ are good with `stack-os-matrix` too, right? Other than that, good to go.

            Show
            jsick Jonathan Sick added a comment - Looks good in principle. The only necessary change is fix up the location of _ all _ to follow the Developer Guide . I assume you've checked that the additions of _ all _ are good with `stack-os-matrix` too, right? Other than that, good to go.
            Hide
            sullivan Ian Sullivan added a comment -

            I moved theĀ `_all_` declarations above the imports, and the rebased changes pass Jenkins.

            Show
            sullivan Ian Sullivan added a comment - I moved theĀ `_ all _` declarations above the imports, and the rebased changes pass Jenkins.

              People

              • Assignee:
                sullivan Ian Sullivan
                Reporter:
                sullivan Ian Sullivan
                Reviewers:
                Jonathan Sick
                Watchers:
                Ian Sullivan, Jonathan Sick
              • Votes:
                0 Vote for this issue
                Watchers:
                2 Start watching this issue

                Dates

                • Created:
                  Updated:
                  Resolved:

                  Summary Panel