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

Unpin Documenteer's sphinx extensions and test against representative downstream users

    XMLWordPrintable

    Details

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

      Description

      One of our goals with Documenteer 0.6 is to track the latest versions of Sphinx and Sphinx extensions so that we can start to take advantage of new functionality and bug fixes.

      We've already removed the pin on Sphinx itself; the purpose of this ticket is to start removing pins on extensions such as numpydoc, automodapi, and sphinx-click.

      Part of this ticket will be to test Documenteer against stack documention, technote, and package documentation builds. And hopefully to develop a way to semi-automate this sort of downstream test suite.

        Attachments

          Issue Links

            Activity

            Hide
            jsick Jonathan Sick added a comment -

            I've confirmed that it's possible to build the pipelines with Sphinx 3.2, provided one uses the master branch version of automodapi. Until automodapi 1.13 is released, it's necessary to pin sphinx < 3, > 2.

            Show
            jsick Jonathan Sick added a comment - I've confirmed that it's possible to build the pipelines with Sphinx 3.2, provided one uses the master branch version of automodapi . Until automodapi 1.13 is released, it's necessary to pin sphinx < 3, > 2.

              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: