We’re interested in using docc to generate internal documentation (I.e., documentation to be consumed internally by our teams) that covers several module types, including application and framework targets. Ideally that list would even include generic non-code targets for high level reference and introductory information.
Perhaps it’s useful to think of the portfolio of the things a development team has to deal with:
- High level introductory and cross cutting information, including information not directly related to specific build targets.
- Documentation concerning individual targets, and very specifically both applications and frameworks, covering classes both public and private.
… and once-written, to be able to statically host such files on a service such as GitHub pages, automatically as part of a ci process.
I’ve been following along just enough to perceive, I think, that most of that is not possible with the current docc release, but that some of it may be possible in the next release. Can anybody summarize the current state of progress on what seem to be the following pain points?
- Docs on non-framework target such as applications.
- Docs on public as well as non-public classes/structs.
- Docs not associated with an executable/framework target at all.
- Generation of docs suitable for static hosting.
I’d love to know (a) whether any of that is possible today using official docc releases and (b) what is likely to be available in the next release. These are things which currently seem to gate our ability to use docc: having these abilities would make it a useful tool for us.