jazzy 0.11.0 → 0.11.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6439cb8dc035d69bb0243f06e3b7140b079dd6892840b49e015be636efa7ff64
-  data.tar.gz: fc97247251923d0f385637721405435e2a3211110c14369876767e2572a25175
+  metadata.gz: 7c8747a4dce6e077126ed85f1edf28d1086a91f803be85d79980408a615c826c
+  data.tar.gz: 94584ede0b4365b7412e07914048961fcd84a3d0f9fe568047a3c4569cbd4b4f
 SHA512:
-  metadata.gz: 4049263b20f10ed92f23f23971df8d2fd57a58d95f0312fd34c5c36f1be170b6889ea82a31f3a972505025d69e4ce3f0b55343b17794ccff06bde3a46d87db3c
-  data.tar.gz: 10ac755d262c1a19c451b8dce5969924bd95f1f5601ae5f76c2fb748ac6f74d92b3bc6240334a185da3a6a8987a29ea3cc27c138b666d6e95ed0ed9ea930d833
+  metadata.gz: 6c5a22a98d6f7669f1555f8196aea1a0ae9cea6f1a1e08044b8eca819e8e0a1f50976b42570a8f954d23eaa2e4ed9d6f8231335b2751a7d993063829282917bb
+  data.tar.gz: 30b9480645fdff451fc3bf5856c1ffb3bb0aca32349c28c55ccecc0252e5ee13238968db5908c4d90f23f6c748a0ca30d285d429291327c6a41165d7fa0b0ef8

data/CHANGELOG.md

@@ -1,3 +1,20 @@
+## 0.11.1
+
+##### Breaking
+
+* None.
+
+##### Enhancements
+
+* None.
+
+##### Bug Fixes
+
+* Don't use SwiftPM if there is an Xcode workspace or project in a non-root
+  directory.  
+  [John Fairhurst](https://github.com/johnfairh)
+  [#1103](https://github.com/realm/jazzy/issues/1103)
+
 ## 0.11.0
 
 ##### Breaking

data/README.md

@@ -23,8 +23,11 @@ unacceptable behavior to [info@realm.io](mailto:info@realm.io).
 
 ## Requirements
 
-* Development tools that can build the project you wish to document.  Jazzy supports
-  both [Xcode][xcode] and [Swift Package Manager][spm] projects.
+You need development tools to build the project you wish to document.  Jazzy supports
+both [Xcode][xcode] and [Swift Package Manager][spm] projects.
+
+Jazzy expects to be running on __macOS__.  See [below](#linux) for tips to run Jazzy
+on Linux.
 
 ## Installation
 
@@ -242,6 +245,24 @@ For example to use Xcode 9.4:
 jazzy --swift-version 4.1.2
 ```
 
+## Linux
+
+Jazzy uses [SourceKitten][sourcekitten] to communicate with the Swift build
+environment and compiler.  The `sourcekitten` binary included in the Jazzy gem
+is built for macOS and so does not run on other operating systems.
+
+To use Jazzy on Linux you first need to install and build `sourcekitten`
+following instructions from [SourceKitten's GitHub repository][sourcekitten].
+
+Then to generate documentation for a SwiftPM project, instead of running just
+`jazzy` do:
+```shell
+sourcekitten doc --spm > doc.json
+jazzy --sourcekitten-sourcefile doc.json
+```
+
+We hope to improve this process in the future.
+
 ## Troubleshooting
 
 ### Swift

data/lib/jazzy/gem_version.rb

@@ -1,3 +1,3 @@
 module Jazzy
-  VERSION = '0.11.0'.freeze unless defined? Jazzy::VERSION
+  VERSION = '0.11.1'.freeze unless defined? Jazzy::VERSION
 end

data/lib/jazzy/sourcekitten.rb

@@ -185,7 +185,9 @@ module Jazzy
     def self.use_spm?(options)
       options.swift_build_tool == :spm ||
         (!options.swift_build_tool_configured &&
-         Dir['*.xcodeproj'].empty?)
+         Dir['*.xcodeproj', '*.xcworkspace'].empty? &&
+         !options.build_tool_arguments.include?('-project') &&
+         !options.build_tool_arguments.include?('-workspace'))
     end
 
     # Builds SourceKitten arguments based on Jazzy options

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jazzy
 version: !ruby/object:Gem::Version
-  version: 0.11.0
+  version: 0.11.1
 platform: ruby
 authors:
 - JP Simard
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-09-13 00:00:00.000000000 Z
+date: 2019-09-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cocoapods
@@ -279,7 +279,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubyforge_project: 
+rubygems_version: 2.7.3
 signing_key: 
 specification_version: 4
 summary: Soulful docs for Swift & Objective-C.