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

Clean up build warnings in Developer Guide and enable "nitpick" mode

    XMLWordPrintable

Details

    Description

      Build warnings continue to creep into the Developer Guide:

      /Users/jsick/lsst/dm_dev_guide/services/storage.rst:27: SEVERE: Unexpected section title or transition.
       
      ======
      /Users/jsick/lsst/dm_dev_guide/services/storage.rst:37: SEVERE: Unexpected section title or transition.
       
      -------------------------------------------------------------------------------------
      /Users/jsick/lsst/dm_dev_guide/services/storage.rst:40: WARNING: Block quote ends without a blank line; unexpected unindent.
      /Users/jsick/lsst/dm_dev_guide/services/storage.rst:40: SEVERE: Unexpected section title or transition.
       
      --------------------------------------------------------------------------------------
      /Users/jsick/lsst/dm_dev_guide/services/storage.rst:43: WARNING: Block quote ends without a blank line; unexpected unindent.
      /Users/jsick/lsst/dm_dev_guide/services/storage.rst:43: SEVERE: Unexpected section title or transition.
       
      -------------------------------------------------------------------------------------
      looking for now-outdated files... none found
      pickling environment... done
      checking consistency... /Users/jsick/lsst/dm_dev_guide/services/ldf-resources.rst:: WARNING: document isn't included in any toctree
      /Users/jsick/lsst/dm_dev_guide/services/ldf-tickets.rst:: WARNING: document isn't included in any toctree
      /Users/jsick/lsst/dm_dev_guide/services/storage.rst:: WARNING: document isn't included in any toctree
      done
      preparing documents... done
      writing output... [100%] work/project-planning
      /Users/jsick/lsst/dm_dev_guide/cpp/style.rst:106: WARNING: undefined label: pipelines:source-install-redhat-legacy (if the link has no caption the label must precede a section header)
      

      This ticket is to fix the existing syntax issues and then prevent future issues by enabling the "error on warnings" aka nitpick mode for Sphinx.

      Attachments

        Activity

          No builds found.
          jsick Jonathan Sick created issue -
          jsick Jonathan Sick made changes -
          Field Original Value New Value
          Epic Link DM-12790 [ 36408 ]
          jsick Jonathan Sick made changes -
          Risk Score 0

          It might also be good to update the CONTRIBUTING documentation for the Developer Guide to point out how to find the Travis CI page.

          jsick Jonathan Sick added a comment - It might also be good to update the CONTRIBUTING documentation for the Developer Guide to point out how to find the Travis CI page.
          jsick Jonathan Sick made changes -
          Story Points 0.2
          jsick Jonathan Sick made changes -
          Resolution Done [ 10000 ]
          Status To Do [ 10001 ] Done [ 10002 ]

          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.