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

Update documenteer with compatibility for Sphinx >= 2.0

    XMLWordPrintable

    Details

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

      Description

      We'd like to update documenteer so that it's compatible with Sphinx 2.0 (up to the modern 2.2). This is necessary so that we can use the latest versions of Breathe, which now require Sphinx 2.0.

      One known issue with the Sphinx runner; the API there changed.

      Another potential issue is documented in https://github.com/lsst-sqre/documenteer/issues/47

        Attachments

          Issue Links

          is blocked by

          Bug - A problem which impairs or prevents the functions of the product. DM-20866 Fix package-docs recursion depth error from rebuilds

          • Done
          relates to

          Bug - A problem which impairs or prevents the functions of the product. DM-22572 Fix script insertion in lsst-sphinx-bootstrap-theme for Sphinx 2.0

          • Done

            Activity

            Hide
            Permalink
            jsick Jonathan Sick added a comment -
            • Documenteer now works with Sphinx 2.0+.
              By default, Documenteer will install the latest version of Sphinx for you.
              Other dependency upgrades:
            • The ``click`` version now floats.
            • ``numpydoc`` is pinned at 0.8.0.
            • ``sphinx-automodapi`` is pinned at 0.12.
            • ``breathe`` is pinned at 4.14.0.

            Updates to development or test dependencies:

            • pytest is pinned to 4.5.0.
            • sphinx-click is pinned to 2.3.1.
            • Python 3.6 is no longer officially supported.
              Documenteer is tested with Python 3.7.

            Tested with technote, stack package, and pipelines.lsst.io builds.

            Show
            jsick Jonathan Sick added a comment - Documenteer now works with Sphinx 2.0+. By default, Documenteer will install the latest version of Sphinx for you. Other dependency upgrades: The ``click`` version now floats. ``numpydoc`` is pinned at 0.8.0. ``sphinx-automodapi`` is pinned at 0.12. ``breathe`` is pinned at 4.14.0. Updates to development or test dependencies: pytest is pinned to 4.5.0. sphinx-click is pinned to 2.3.1. Python 3.6 is no longer officially supported. Documenteer is tested with Python 3.7. Tested with technote, stack package, and pipelines.lsst.io builds.

              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.