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

Add a "fail on warnings" mode to Documenteer package-docs build and stack-docs build command

    XMLWordPrintable

    Details

    • Type: Story
    • Status: To Do
    • Resolution: Unresolved
    • Fix Version/s: None
    • Component/s: None
    • Labels:
      None

      Description

      To assist teams that want a warning-free documentation build, let's add access to Sphinx's "nitpicky" build mode that fails a build (returning non-zero status) if warnings are emitted during the Sphinx build. This will be an option since its expected that package documentation builds for stacks will emit link warnings if the documentation uses ref or doc roles across packages.

        Attachments

          Activity

          There are no comments yet on this issue.

            People

            Assignee:
            jsick Jonathan Sick
            Reporter:
            jsick Jonathan Sick
            Watchers:
            Jonathan Sick, Tim Jenness
            Votes:
            0 Vote for this issue
            Watchers:
            2 Start watching this issue

              Dates

              Created:
              Updated:

                Jenkins

                No builds found.