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

Documenteer: Fix jinja2 3.1 incompatibility for Documenteer 0.5

    XMLWordPrintable

    Details

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

      Description

      The Documenteer 0.5 release series pins Sphinx<2. That old version of Sphinx has an API that's incompatible with Jinja2 3.1 and later. Thus for the Documenteer 0.5 back ports, let's add a requirement on jinja2<3.1. This is needed in particular for most technotes that use documenteer 0.5, as well as many documentation sites such as obs-ops.lsst.io.

      No action is needed for main branch development (Documenteer 0.6).

        Attachments

          Issue Links

          relates to

          Story - Created by Jira Software - do not edit or delete. Issue type for a user story. DM-34231 templates: Migrate rst technote template to use Documenteer 0.6

          • Done

            Activity

            Hide
            Permalink
            jsick Jonathan Sick added a comment -

            Summary from conversation on #ts-docs:

            https://lsstc.slack.com/archives/CFPJM3551/p1648577354250839?thread_ts=1648569171.080449&cid=CFPJM3551

            To summarize the resolution:

            1. I've updated the LTD configs for all projects based out of the github.com/lsst-ts to use main as the default branch; if some repos are still using master let me know and I can revert them specifically.
            2. I've released documenteer 0.5.10 that fixes the jinja2-related build issue you may have seen. No need to pin jinja2 specifically in your projects anymore
            3. I've created a PR for obervatory-ops-docs to update it to the latest documenteer and update some configs: https://github.com/lsst-ts/observatory-ops-docs/pull/27 (note base branch is wrong, pointing to Times Square work)
            Show
            jsick Jonathan Sick added a comment - Summary from conversation on #ts-docs: https://lsstc.slack.com/archives/CFPJM3551/p1648577354250839?thread_ts=1648569171.080449&cid=CFPJM3551 To summarize the resolution: I've updated the LTD configs for all projects based out of the github.com/lsst-ts to use main as the default branch; if some repos are still using master let me know and I can revert them specifically. I've released documenteer 0.5.10 that fixes the jinja2-related build issue you may have seen. No need to pin jinja2 specifically in your projects anymore I've created a PR for obervatory-ops-docs to update it to the latest documenteer and update some configs: https://github.com/lsst-ts/observatory-ops-docs/pull/27 (note base branch is wrong, pointing to Times Square work)

              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.