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

Integrate Documenteer's Sphinx building commands with sconsUtils

    XMLWordPrintable

    Details

      Description

      Integrate Documenteer into sconsUtils so that triggering scons will drive either:

        Attachments

          Issue Links

            Activity

            Hide
            tjenness Tim Jenness added a comment -

            We must be pretty close to being able to do this now. Documenteer is part of rubin-env and many packages now build with package-docs.

            Show
            tjenness Tim Jenness added a comment - We must be pretty close to being able to do this now. Documenteer is part of rubin-env and many packages now build with package-docs.
            Hide
            jsick Jonathan Sick added a comment -

            Yeah, it's an idea worth considering.

            When implementing this, we'd need to keep in mind that for individual package builds this would need to be an optional step since package-docs build is known (no real way around it) to throw errors/warnings for broken links since the build isn't happening in the real context of a pipelines.lsst.io build.

            Show
            jsick Jonathan Sick added a comment - Yeah, it's an idea worth considering. When implementing this, we'd need to keep in mind that for individual package builds this would need to be an optional step since package-docs build is known (no real way around it) to throw errors/warnings for broken links since the build isn't happening in the real context of a pipelines.lsst.io build.
            Hide
            krzys Krzysztof Findeisen added a comment - - edited

            Why would that be a problem? Doxygen also emits lots of warnings, and it's rare for people to actually track them down and fix them...

            And the broken links for Sphinx are warnings: you still get a complete build at the end, just with the links substituted with plain text.

            Show
            krzys Krzysztof Findeisen added a comment - - edited Why would that be a problem? Doxygen also emits lots of warnings, and it's rare for people to actually track them down and fix them... And the broken links for Sphinx are warnings: you still get a complete build at the end, just with the links substituted with plain text.
            Hide
            jsick Jonathan Sick added a comment -

            John Parejko Here's the ticket if you'd like to tackle it.

             

            Krzysztof Findeisen It can be an issue if the sphinx-build is run in a mode where warning are elevated into errors, which I know some folks do. So we'd just have to manage expectations and use that "warnings as errors" appropriately.

            Show
            jsick Jonathan Sick added a comment - John Parejko  Here's the ticket if you'd like to tackle it.   Krzysztof Findeisen  It can be an issue if the sphinx-build is run in a mode where warning are elevated into errors, which I know some folks do. So we'd just have to manage expectations and use that "warnings as errors" appropriately.

              People

              Assignee:
              Parejkoj John Parejko
              Reporter:
              jsick Jonathan Sick
              Watchers:
              Jonathan Sick, Krzysztof Findeisen, Tim Jenness
              Votes:
              0 Vote for this issue
              Watchers:
              3 Start watching this issue

                Dates

                Created:
                Updated:

                  Jenkins

                  No builds found.