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

Documenteer: Patch 0.5 series to unpin numpydoc 0.5

    XMLWordPrintable

    Details

    • Type: Story
    • Status: Done
    • Resolution: Done
    • Fix Version/s: None
    • Component/s: None
    • Labels:
      None

      Description

      Numpydoc 0.8 is not compatible with Python 3.10:

       File "/j/ws/sqre/infra/documenteer/doc_template/home/.local/lib/python3.10/site-packages/numpydoc/docscrape.py", line 109, in <module>
          class NumpyDocString(collections.Mapping):
      AttributeError: module 'collections' has no attribute 'Mapping'
      

      Solution is to make a release to the documenteer 0.5 line that pipelines.lsst.io is currently using that uses a more recent version of numpydoc. I believe that numpydoc < 1.3 is the last version compatible with Sphinx < 3.

      See Slack conversation: https://lsstc.slack.com/archives/C2B6DQBAL/p1653493483628069

        Attachments

          Activity

          Hide
          jsick Jonathan Sick added a comment -

          Released documenteer 0.5.11 via https://github.com/lsst-sqre/documenteer/pull/117

          This is triggering pipelines.lsst.io build issues because the new version of numpydoc (1.2, up from 0.8) is pickier about docstring formatting. We'll need to comprehensively clean up docstrings in packages to restore doc builds.

          Show
          jsick Jonathan Sick added a comment - Released documenteer 0.5.11 via https://github.com/lsst-sqre/documenteer/pull/117 This is triggering pipelines.lsst.io build issues because the new version of numpydoc (1.2, up from 0.8) is pickier about docstring formatting. We'll need to comprehensively clean up docstrings in packages to restore doc builds.
          Hide
          jsick Jonathan Sick added a comment -

          Turns out only one docstring needed to be changed in pipe_base, all good now.

          Show
          jsick Jonathan Sick added a comment - Turns out only one docstring needed to be changed in pipe_base , all good now.

            People

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

              Dates

              Created:
              Updated:
              Resolved:

                Jenkins

                No builds found.