Uploaded image for project: 'CDAP'
  1. CDAP
  2. CDAP-2552

Documentation Build script should flag errors

    Details

    • Type: Improvement
    • Status: Resolved
    • Priority: Major
    • Resolution: Fixed
    • Affects Version/s: 3.0.0
    • Fix Version/s: 3.1.0
    • Component/s: Build System, Docs
    • Labels:
    • Rank:
      1|hzytov:

      Description

      Currently, the only way to tell that there are errors in the documentation build is to either look at the resulting output file (a zip) and look at the output log of the build script.

      If you search through the build script, you can find Sphinx (and other errors), but that means looking back through what can be quite a long log, especially if the Javadocs have been built.

      It would be better if the script itself kept track of success, warnings, and failures, and reported at the end in its closing block what it did (or didn't) accomplish.

        Attachments

          Activity

            People

            • Assignee:
              John John Jackson
              Reporter:
              John John Jackson
            • Votes:
              0 Vote for this issue
              Watchers:
              1 Start watching this issue

              Dates

              • Created:
                Updated:
                Resolved: