swift-doc v1.0.0-beta.3 Release Notes

Release Date: 2020-05-19 // almost 4 years ago
  • ➕ Added

    • ➕ Added --base-url option.
      #65 by @kean and #93 by @mattt.
    • ➕ Added asset pipeline for CSS assets.
      #49 by @kaishin.
    • ➕ Add swift-doc version number to command and generated output.
      #94 by @mattt.

    🔄 Changed

    • 🔄 Changed Home page to display globals for HTML format.
      #81 by @kean.
    • 🔄 Changed README to clarify use of swift-doc vs. swift doc
      💻 on the command line.
      #89 by @mattt.
    • 🔄 Changed the generate command to emit a warning if no source
      files are found.
      #92 by @heckj
    • 🔄 Changed CommonMark format output of Home page
      to include summaries alongside top-level symbols, when available.
      #97 by @mattt.
    • 🔄 Changed logging behavior to better communicate errors encountered
      when generating relationship graphs using GraphViz.
      #100 by @mattt.
    • 🔄 Changed HTML format output of Home page
      🚚 to move enumeration cases under initializers.
      #103 by @mattt.

    🛠 Fixed

    • 🛠 Fixed relationship handling for members of nested types.
      #62 by @victor-pavlychko.
    • 🛠 Fixed rendering of type relationships section when no graph data is available.
      #62 by @victor-pavlychko.
    • 🛠 Fixed rendering of protocol requirements in the HTML version.
      #76 by @victor-pavlychko.
    • 🛠 Fixed default location of sources reference in README
      #92 by @heckj
    • 🛠 Fixed indentation of code examples in HTML output.
      #114 by @samsymons
    • 🛠 Fixed icons for symbols in HTML output.
      #115 by @samsymons