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

Patch documenteer for Sphinx 1.8.0 incompatibility

    XMLWordPrintable

Details

    Description

      With the release of Sphinx 1.8.0, documenteer's Sphinx runner appears to be broken:

      build succeeded, 110 warnings.
       
      The HTML pages are in _build/html.
       
      Traceback (most recent call last):
        File "/Users/jsick/lsst/pipelines_lsst_io_stack/stacks/w_2018_37/python/miniconda3-4.5.4/envs/lsst-scipipe-fcd27eb/lib/python3.6/site-packages/documenteer/sphinxrunner.py", line 86, in run_sphinx
          return app.statuscode
        File "/Users/jsick/lsst/pipelines_lsst_io_stack/stacks/w_2018_37/python/miniconda3-4.5.4/envs/lsst-scipipe-fcd27eb/lib/python3.6/contextlib.py", line 88, in __exit__
          next(self.gen)
        File "/Users/jsick/lsst/pipelines_lsst_io_stack/stacks/w_2018_37/python/miniconda3-4.5.4/envs/lsst-scipipe-fcd27eb/lib/python3.6/site-packages/sphinx/util/docutils.py", line 144,in patch_docutils
          yield
        File "/Users/jsick/lsst/pipelines_lsst_io_stack/stacks/w_2018_37/python/miniconda3-4.5.4/envs/lsst-scipipe-fcd27eb/lib/python3.6/contextlib.py", line 88, in __exit__
          next(self.gen)
        File "/Users/jsick/lsst/pipelines_lsst_io_stack/stacks/w_2018_37/python/miniconda3-4.5.4/envs/lsst-scipipe-fcd27eb/lib/python3.6/site-packages/sphinx/util/docutils.py", line 134,in using_user_docutils_conf
          os.environ.pop('DOCUTILSCONFIG')
        File "/Users/jsick/lsst/pipelines_lsst_io_stack/stacks/w_2018_37/python/miniconda3-4.5.4/envs/lsst-scipipe-fcd27eb/lib/python3.6/_collections_abc.py", line 795, in pop
          value = self[key]
        File "/Users/jsick/lsst/pipelines_lsst_io_stack/stacks/w_2018_37/python/miniconda3-4.5.4/envs/lsst-scipipe-fcd27eb/lib/python3.6/os.py", line 669, in __getitem__
          raise KeyError(key) from None
      KeyError: 'DOCUTILSCONFIG'
       
      Exception occurred:
        File "/Users/jsick/lsst/pipelines_lsst_io_stack/stacks/w_2018_37/python/miniconda3-4.5.4/envs/lsst-scipipe-fcd27eb/lib/python3.6/os.py", line 669, in __getitem__
          raise KeyError(key) from None
      KeyError: 'DOCUTILSCONFIG'
      

      Note that the HTML is built successfully, but the command returns a non-zero build status that is breaking the Jenkins build.

      I think the most expedient solution is to pin Sphinx to <1.8.0 and solve the 1.8.0 compatibility later. We can probably release this new version as Documenteer 0.3.0 (out of beta).

      Attachments

        Activity

          There are no comments yet on this issue.

          People

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

            Dates

              Created:
              Updated:
              Resolved:

              Jenkins

                No builds found.