cocoapods/cocoapods-docs

Simple gem which offers convenient access to the documentation of a Pod via cocoadocs.org.

CocoaPods: The Cocoa dependency manager

CocoaPods manages dependencies for your Xcode projects.

You specify the dependencies for your project in a simple text file: your Podfile. CocoaPods recursively resolves dependencies between libraries, fetches source code for all dependencies, and creates and maintains an Xcode workspace to build your project. The latest released Xcode versions and the prior version are supported.

Installing and updating CocoaPods is very easy. Don't miss the Installation guide and the Getting Started guide.

Project Goals

CocoaPods aims to improve the engagement with, and discoverability of, third party open-source Cocoa libraries. These project goals influence and drive the design of CocoaPods:

• Create and share libraries, and use them in your own projects, without creating extra work for library authors. Integrate non-CocoaPods libraries and hack on your own fork of any CocoaPods library with a simple transparent Podspec standard.
• Allow library authors to structure their libraries however they like.
• Save time for library authors by automating a lot of Xcode work not related to their libraries' functionality.
• Support any source management system. (Currently supported are git, svn, mercurial, bazaar, and various types of archives downloaded over HTTP.)
• Promote a culture of distributed collaboration on pods, but also provide features only possible with a centralised solution to foster a community.
• Build tools on top of the core Cocoa development system, including those typically deployed to other operating systems, such as web-services.
• Provide opinionated and automated integration, but make it completely optional. You may manually integrate your CocoaPods dependencies into your Xcode project as you see fit, with or without a workspace.
• Solve everyday problems for Cocoa and Xcode developers.

Sponsors

Lovingly sponsored by a collection of companies, see the footer of CocoaPods.org for an up-to-date list.

Collaborate

All CocoaPods development happens on GitHub. Contributions make for good karma and we welcome new contributors with joy. We take contributors seriously, and thus have a contributor code of conduct.

Links

Link	Description
CocoaPods.org	Homepage and search for Pods.
@CocoaPods	Follow CocoaPods on Twitter to stay up to date.
Blog	The CocoaPods blog.
Mailing List	Feel free to ask any kind of question.
Guides	Everything you want to know about CocoaPods.
Changelog	See the changes introduced in each CocoaPods version.
New Pods RSS	Don't miss any new Pods.
Code of Conduct	Find out the standards we hold ourselves to.

Projects

CocoaPods is composed of the following projects:

Status	Project	Description	Info
	CocoaPods	The CocoaPods command line tool.	guides
	CocoaPods Core	Support for working with specifications and podfiles.	docs
	CocoaPods Downloader	Downloaders for various source types.	docs
	Xcodeproj	Create and modify Xcode projects from Ruby.	docs
	CLAide	A small command-line interface framework.	docs
	Molinillo	A powerful generic dependency resolver.	docs
	Master Repo	Master repository of specifications.	guides

cocoapods-docs's Issues

Doc is not generated for new pod

Hi, I created my new pod yesterday but it seems to have some problems generating docs for it.

http://cocoadocs.org/docsets/Fuzi/0.1.0/

I have successfully generated docs locally using latest master branch of jazzy, any idea what the problem is?

btw, the header doc is in swift 2.0 format

Incorrect View on GitHub link on rubydoc

Probably not the best place to post this, but I don't know where else.

As a concrete example, on

http://www.rubydoc.info/github/CocoaPods/Xcodeproj/Xcodeproj%2FProject%2FObject%2FXCBuildConfiguration:build_settings

the View on GitHub link points to

https://github.com/CocoaPods/Xcodeproj/blob/Xcodeproj%2FProject%2FObject%2FXCBuildConfiguration:build_settings/lib/xcodeproj/project/object/build_configuration.rb#L17

and on

http://www.rubydoc.info/github/CocoaPods/Xcodeproj/Xcodeproj/Project/Object/XCBuildConfiguration#build_settings-instance_method

it points to

https://github.com/CocoaPods/Xcodeproj/blob/Xcodeproj/lib/xcodeproj/project/object/build_configuration.rb#L17

instead of

https://github.com/CocoaPods/Xcodeproj/blob/master/lib/xcodeproj/project/object/build_configuration.rb#L17

Pod Homepage is redirecting to source git repo

Report

What did you do?

pod trunk push --allow-warnings

What did you expect to happen?

Pod published Successfully but pod homepage(https://cocoapods.org/pods/IBMAppLaunch) is redirecting to git repo.

Pod Homegepage(https://cocoapods.org/pods/IBMAppLaunch) is getting redirected to git repo

What happened instead?

Pod Homegepage(https://cocoapods.org/pods/IBMAppLaunch) is getting redirected to git repo

CocoaPods Environment

Stack

   CocoaPods : 1.3.1
        Ruby : ruby 2.3.3p222 (2016-11-21 revision 56859) [universal.x86_64-darwin17]
    RubyGems : 2.5.2
        Host : Mac OS X 10.13.1 (17B1003)
       Xcode : 9.1 (9B55)
         Git : git version 2.13.6 (Apple Git-96)
Ruby lib dir : /System/Library/Frameworks/Ruby.framework/Versions/2.3/usr/lib
Repositories : danijelhuis - https://github.com/DanijelHuis/HDAugmentedReality.git @ e7a9b0804325a3699800ae071ef8ad5f4a3bbb44
               master - https://github.com/CocoaPods/Specs.git @ a2a64bb791f062ef4fc9d21f3cf0f918b56401fa
               vittalpai - https://github.com/vittalpai/JSONStoreAPI.git @ 7279bbbc6c37771126c32837d70591d87b0ef24e

Installation Source

Executable Path: /Users/vittal/.rvm/gems/ruby-2.4.1/bin/pod

Plugins

cocoapods-deintegrate : 1.0.1
cocoapods-plugins     : 1.0.0
cocoapods-search      : 1.0.0
cocoapods-stats       : 1.0.0
cocoapods-trunk       : 1.3.0
cocoapods-try         : 1.1.0

Podfile

# Uncomment the next line to define a global platform for your project
# platform :ios, '9.0'

target 'AppLaunch' do
    use_frameworks!
    platform :ios, '9.0'
    pod 'BMSCore', '~> 2.0'
    pod 'SwiftyJSON', '~> 4.0.0'
end

post_install do |installer|
    installer.pods_project.targets.each do |target|
        target.build_configurations.each do |config|
            config.build_settings['SWIFT_VERSION'] = '3.2'
        end
    end
end

Add support for docset generation

Instead of simply open cocoadocs.org it would be really great to be able to generate the docset of the pod and integrate it in Xcode

• we may download it from cocoadocs.org (if it is available in s3 directly?) but that won't work for private pods (hosted in private specs repos and not in Cocoapods/Specs.git)
• we may generate it on demand (it would require appledoc to be installed, except if we integrate the binary in the gem) but would work for any pod even private ones

As I use private hosted pods for the components of my company, I would opt for the second solution ;)

See also CocoaPods/CocoaPods#1236 (comment)

Broken layout

I don't know if it's related strictly to Swift pods, or general issue, but somethimes layout is broken.

http://cocoadocs.org/docsets/CryptoSwift/0.0.4/

Pages are not searchable

When I read through the docs I really want to search the entire page to jump to examples for creating a podspec. The problem is that the content is hidden because of how the navigation works. It's clever but not helpful. There also needs to be more examples of various ways each setting can be used. Specifically, what if I have more complex requirements for source_files or dependency. I eventually figured out that I can create a comma delimited list for source_files while dependency allows for multiple lines which is not intuitive to me as I do not know Ruby. More examples and making it easy to get to the content would save developers so much time.

No profile created for my Pod on CocoaPods.org

This is my project: https://cocoapods.org/?q=zingle

This is project's Github URL: https://github.com/hemangshah/Zingle

But I can't see a profile on CocoaPods.org.

There's no expand button for it.

What am I missing?