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

Pin pybtex/sphinxcontrib-bibtex dependencies in documenteer 0.2.x & dev guide update

    Details

      Description

      The Dev Guide suggests we use the following:

      .. bibliography:: local.bib lsstbib/books.bib lsstbib/lsst.bib lsstbib/lsst-dm.bib lsstbib/refs.bib lsstbib/refs_ads.bib
         :encoding: latex+latin
         :style: lsst_aa
      

      However, when I tried this with a recent sphinxcontrib-bibtex, I get:

      /Users/jds/Projects/LSST/docs/dmtn/031/index.rst:508: ERROR: Error in "bibliography" directive:
      invalid option value: (option: "encoding"; value: 'latex+latin')
      unknown encoding: "latex+latin".
       
      .. bibliography:: lsst-texmf/texmf/bibtex/bib/refs_ads.bib
         :style: lsst_aa
         :encoding: latex+latin
      

      I think this is due to changes upstream (I didn't track it down fully, but I note that both sphixcontrib-bibtex and pybtex have been making changes to the way they handle encodings in recent releases).

      Simply removing the :encoding: line works fine for me.

        Attachments

          Activity

          swinbank John Swinbank created issue -
          swinbank John Swinbank made changes -
          Field Original Value New Value
          Risk Score 0
          swinbank John Swinbank made changes -
          Assignee John Swinbank [ swinbank ] Jonathan Sick [ jsick ]
          swinbank John Swinbank made changes -
          Team SQuaRE [ 10302 ]
          swinbank John Swinbank made changes -
          Description The Dev Guide suggests we use the following:

          {code}
          .. bibliography:: local.bib lsstbib/books.bib lsstbib/lsst.bib lsstbib/lsst-dm.bib lsstbib/refs.bib lsstbib/refs_ads.bib
             :encoding: latex+latin
             :style: lsst_aa
          {code}

          However, when I tried this with a recent sphinxcontrib-bibtex, I get:

          {code}
          Users/jds/Projects/LSST/docs/dmtn/031/index.rst:508: ERROR: Error in "bibliography" directive:
          invalid option value: (option: "encoding"; value: 'latex+latin')
          unknown encoding: "latex+latin".

          .. bibliography:: lsst-texmf/texmf/bibtex/bib/refs_ads.bib
             :style: lsst_aa
             :encoding: latex+latin
          {code}

          I think this is due to changes upstream (I didn't track it down fully, but I note that both sphixcontrib-bibtex and pybtex have been making changes to the way they handle encodings in recent releases).

          Simply removing the {{:encoding:}} line works fine for me.
          The Dev Guide suggests we use the following:

          {code}
          .. bibliography:: local.bib lsstbib/books.bib lsstbib/lsst.bib lsstbib/lsst-dm.bib lsstbib/refs.bib lsstbib/refs_ads.bib
             :encoding: latex+latin
             :style: lsst_aa
          {code}

          However, when I tried this with a recent sphinxcontrib-bibtex, I get:

          {code}
          /Users/jds/Projects/LSST/docs/dmtn/031/index.rst:508: ERROR: Error in "bibliography" directive:
          invalid option value: (option: "encoding"; value: 'latex+latin')
          unknown encoding: "latex+latin".

          .. bibliography:: lsst-texmf/texmf/bibtex/bib/refs_ads.bib
             :style: lsst_aa
             :encoding: latex+latin
          {code}

          I think this is due to changes upstream (I didn't track it down fully, but I note that both sphixcontrib-bibtex and pybtex have been making changes to the way they handle encodings in recent releases).

          Simply removing the {{:encoding:}} line works fine for me.
          jsick Jonathan Sick made changes -
          Summary Developer Guide gives outdated advice about BibTeX encoding for ReST Pin pybtex/sphinxcontrib-bibtex dependencies in documenteer 0.2.x & dev guide update
          jsick Jonathan Sick made changes -
          Status To Do [ 10001 ] In Progress [ 3 ]
          jsick Jonathan Sick made changes -
          Story Points 0.2
          jsick Jonathan Sick made changes -
          Epic Link DM-13773 [ 39319 ]
          jsick Jonathan Sick made changes -
          Component/s Stack Documentation and UX [ 12880 ]
          Labels documenteer technote-platform
          swinbank John Swinbank made changes -
          Attachment swinbank-environment.txt [ 32803 ]
          jsick Jonathan Sick made changes -
          Epic Link DM-13773 [ 39319 ] DM-5644 [ 23494 ]
          jsick Jonathan Sick made changes -
          Epic Link DM-5644 [ 23494 ] DM-15819 [ 208467 ]
          jsick Jonathan Sick made changes -
          Story Points 0.2 0.5
          jsick Jonathan Sick made changes -
          Resolution Done [ 10000 ]
          Status In Progress [ 3 ] Done [ 10002 ]

            People

            • Assignee:
              jsick Jonathan Sick
              Reporter:
              swinbank John Swinbank
              Watchers:
              John Swinbank, Jonathan Sick
            • Votes:
              0 Vote for this issue
              Watchers:
              2 Start watching this issue

              Dates

              • Created:
                Updated:
                Resolved:

                Summary Panel