jazzy: Add support for Jazzy for code where a Xcode project doesn't exist

This would be a great feature as I have a framework with no Xcode project.

Converting this issue from a question to a feature request since I agree with @kylebrowning. That would be a cool feature, especially with SPM and non-Xcode proj Swift code.

If your project supports the Swift Package Manager, you don’t need an Xcode project to generate docs for it. For example:

$ brew install sourcekitten
$ git clone https://github.com/qutheory/vapor.git
$ cd vapor
$ git checkout 1.3.8
$ swift build
$ sourcekitten doc --spm-module Vapor > vapor.json
$ jazzy \
  --clean \
  --sourcekitten-sourcefile vapor.json \
  --author Qutheory \
  --author_url http://qutheory.io \
  --github_url https://github.com/qutheory/vapor \
  --github-file-prefix https://github.com/qutheory/vapor/tree/1.3.8 \
  --module-version 1.3.8 \
  --module Vapor \
  --root-url https://static.realm.io/jazzy_demo/Vapor

Which generates this: https://static.realm.io/jazzy_demo/Vapor

At some point, I’ll build a more direct way to do this with a single command using jazzy.

But right now, it’s not too complicated, just three commands: swift build, sourcekitten doc, jazzy.

@cianiandreadev, there is still no progress towards Linux support within the Jazzy project itself—Jazzy is built on top of Xcode.

---

However, if…

• your project has a repository on GitHub
• your project can be built with the Swift Package Manager

…then Workspace can be easily set up with Travis CI to run Jazzy remotely and push the documentation to a gh‐pages branch. (You can pull that branch to copy the documentation elsewhere too.) Here is an example of a project that does it this way.

In this manner Jazzy can be used even if all you have locally are Linux machines.

I’m not familiar with RemObjects Fire, but I use jazzy with the Swift Package Manager.

swift package generate-xcodeproj
jazzy

Making a different type of project look enough like a package to let the Swift Package Manager generate the Xcode project may be relatively simple. Try something like this as a bare‐bones starting point:

cd ../Somewhere/Outside/The/Project
mkdir TemporaryPackage
cd TemporaryPackage
swift package init
cp -r /Path/Of/Actual/Project/Root Sources/TemporaryPackage
rm Sources/TemporaryPackage.swift
swift package generate-xcodeproj
jazzy
cp -r docs /Path/Of/Documentation/Output
cd ..
rm -rf TemporaryPackage

With real paths, the above script is already sufficient to run jazzy, provided the project contains only .swift files . You may need to tailor the script for details like the module name or to remove any filetypes the Swift Package Manager does not understand.

I wrote it in shell so it is fast to try, but the script can also be re‐writen in whatever language you like (Jazzy is in Ruby). Once you get it working for your project, if you decide to modify it to be widely‐applicable and no longer hard coded for your particular project, you can submit a pull request.

I suspect the simplest way to integrate this into Jazzy itself would be a Jazzy configuration option (something like not_an_xcode_project) that causes the before and after sections of the above script (converted to Ruby) to run near the beginning and end of Jazzy’s execution.

Note: All this still assumes Xcode itself is present on the system. Making Jazzy work without it would be tantamount to starting Jazzy over from scratch. Ergo, Jazzy will never run on Linux.