# Enable Sphinx support for ip_diffim

XMLWordPrintable

## Details

• Type: Story
• Status: Done
• Resolution: Done
• Fix Version/s: None
• Component/s:
• Labels:
• Story Points:
1
• Sprint:
AP S18-5
• Team:

## Description

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

## Activity

Hide
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
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
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
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
Ian Sullivan added a comment -

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

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

## People

• Assignee:
Ian Sullivan
Reporter:
Ian Sullivan
Reviewers:
Jonathan Sick
Watchers:
Ian Sullivan, Jonathan Sick