Stack Overflow
Stack Overflow

Questions tagged [jazzy]

jazzy is a command-line utility that generates documentation for Swift or Objective-C.

Github page of the (open source) project: https://github.com/realm/jazzy

34 questions
1
vote
1 answer

nobody can get cocoadocs page for swift framework

Trying to post to CocoaPods, but when the project goes through it doesn’t generate docs (site + docs button, instead of expand). Alternatively, when I specify a docs url the docs button doesn’t work either. According to the guides, it seems like…
Mercutio
  • 1,152
  • 1
  • 14
  • 33
1
vote
1 answer

Why does my iOS project Gemfile bundle update unconsistently?

I have a simple Gemfile for an iOS project using cocoapods: # frozen_string_literal: true source "https://rubygems.org" gem 'cocoapods' gem 'fastlane' gem 'jazzy' I've tried to update my bundle by a bundle update and jazzy went from version 0.8.2…
Mick F
  • 7,312
  • 6
  • 51
  • 98
1
vote
0 answers

error: use of '@import' when modules are disabled

I am running into these errors when running the following command 15:08:48 - tito@lt0311-2 Jazzy(master)> be jazzy --objc --umbrella-header Jazzy/SDK.h --theme apple --framework-root . --sdk iphoneos --module…
Titouan de Bailleul
  • 12,920
  • 11
  • 66
  • 121
1
vote
2 answers

Jazzy Unable to find an Xcode with swift version 2.2. (RuntimeError): Xcode7.3

We are trying to generate the documents for Swift2.2 using Jazzy with Xcode7.3. We have 2 environments: Local dev environment (Macbook) and Server machine for central build. We have exactly same set up in both machine like Xcode,CommandLine…
Sreedhar GS
  • 2,694
  • 1
  • 24
  • 26
1
vote
2 answers

Swift Auto Documentation jazzy for pod folder only

I am writing an SKD in Swift and I have an example project as a target. The target is there for testing the network calls that the SDK makes. My project structure looks something like this -project ->sampleViewController ->storyboard …
Mark Gilchrist
  • 1,972
  • 3
  • 24
  • 44
1
vote
2 answers

Jazzy OSX 10.11.3 Xcode 7.2.1 Issue Finding XCRUN

with the following command line, have the following issue with Jazzy. have checked the command line tools, etc, all looks good. $ echo $PATH /usr/local/bin:/usr/bin:/bin:/usr/sbin:/sbin $ whereis xcrun /usr/bin/xcrun shell command / script jazzy…
ort11
  • 3,359
  • 4
  • 36
  • 69
0
votes
0 answers

Unable to install Jazzy gem in my Mac due to write permission

I am trying to install Jazzy gem in my Mac (macOS Monterey 12.5) but I am getting error of write permission of directory /System/Library/Frameworks/Ruby.framework/Versions/2.6/usr/lib/ruby/gems/2.6.0 , and when I try to set permission to be writable…
GNChishti
  • 39
  • 10
0
votes
0 answers

Upload Attachment to a test artifact with RQM Url Utility (REST API)

I'm using RQM Url Utility for uploading an attachment to RQM 5.0. I've successfully uploaded it using the followinfg command: java -jar RQMUrlUtility.jar -command POST -user xx -password xx -filepath C:\xx.jpg -url…
dell rawal
  • 11
  • 5
0
votes
0 answers

Is it possible to enable keychain without code signing?

I develop a pod library with a demo application. I release it through a CI pipeline with several steps, especially: unit testing and code coverage generation for Sonar doc generation with Jazzy demo app deployment to AppCenter. Since the build may…
Carl Sarkis
  • 119
  • 6
0
votes
1 answer

Swift - adding xcodebuild arguments for Jazzy

I'm trying to use Jazzy to create docs for my xcode project. I'm able to run xcodebuild from my root folder successfully but only using the following arguments: enter code here`xcodebuild -workspace myProj.xcworkspace -scheme "myProj…
DevB1
  • 1,235
  • 3
  • 17
  • 43
0
votes
4 answers

Swift: Jazzy failing to run xcodebuild

I'm trying to generate some documentation for. my project using Jazzy. However, when I run jazzy from the command line I'm getting the following output: Could not successfully run `xcodebuild`. Please check the build arguments. Saved `xcodebuild`…
DevB1
  • 1,235
  • 3
  • 17
  • 43
0
votes
0 answers

How to get Jazzy to ignore Swift Packages

I'm trying to use Jazzy on a project that uses a Swift Package but it fails because of the package. Does anyone know how to get it to ignore them. I've tried a number of options, but none work.
easiwriter
  • 73
  • 1
  • 8
0
votes
1 answer

Edit Jazzy HTML generation to add custom link

I would like to add a link to our main documentation page to every jazzy-generated page. Can anyone point me to the code where the html is actually built? I looked at all the customization options and none of them do what I want. I’ve also looked…
Morgan
  • 1,280
  • 1
  • 14
  • 15
0
votes
1 answer

Jazzy is unable to parse .swift file

I'm trying to create documentation of an Xcode project and I've encountered really weird a problem that I am just not able to solve. I downloaded Jazzy as a tool for creating documentation. I commented / documented several files with no problem, but…
DeepBlue
  • 591
  • 9
  • 18
0
votes
1 answer

How do you write to Jazzy's index.html?

When the Jazzy docs are generated, index.html appears mostly blank except for an "Authors" heading with nothing below it. The examples on the GitHub page show plenty of content in their index.html How can I achieve this same effect and where is…
Ruben A. Santiago
  • 125
  • 8
1
2
3