Skip to content

v0.2.1

Latest

Choose a tag to compare

@rhx rhx released this 15 Nov 10:05

What's New

Links to Symbols Outside the Generated Site

  • References to symbols of modules that are not part of the generated site no longer produce dead links: in declarations, relationship sections such as "Conforms To", and documentation comments, they are shown as plain text, as swift-docc-render shows them
  • --external-docs now applies to these references: with a URL configured for the symbol's module or package, they link to its page in that documentation
  • The key of --external-docs can be a module name or a package name; a package name covers all modules of that package

Fixes

  • Web links in "See Also" sections are listed instead of leaving an empty "Related Documentation" heading
  • Sections with nothing to list are omitted, together with their heading
  • Links to a heading of another page point to that page's file
  • Links to pages whose names start with a period point to the right file

Known Issues

  • Generating documentation on Windows does not work yet