Package manager and swiftdoc


(Luz Violeta) #1

Hello everyone ! o/

I've been poking around with swift on Linux and suddenly I got
interested in how to write docs and generate appropriate
html/pdf/whatever files for consumers of a package.

I found in .build that a binary file *.swiftdoc is generated but I had
no idea if there's a tool available, specs or something to make it
usable ...

Any pointers? Ty for reading


(Rick Ballard) #2

Hi Luz,

We currently have no standard established for generating documentation for packages in a uniform way, but it's in our plans (https://github.com/apple/swift-package-manager/blob/master/Documentation/PackageManagerCommunityProposal.md#documentation-generation). Proposals are welcome for how to do this, via the swift evolution process (https://github.com/apple/swift-evolution/blob/master/process.md)

  - Rick

···

On Dec 13, 2015, at 6:11 PM, Luz Violeta via swift-users <swift-users@swift.org> wrote:

Hello everyone ! o/

I've been poking around with swift on Linux and suddenly I got interested in how to write docs and generate appropriate html/pdf/whatever files for consumers of a package.

I found in .build that a binary file *.swiftdoc is generated but I had no idea if there's a tool available, specs or something to make it usable ...

Any pointers? Ty for reading

_______________________________________________
swift-users mailing list
swift-users@swift.org
https://lists.swift.org/mailman/listinfo/swift-users