Skip to content

docC doesn't play well with cocoapods (Xcode 13 beta 5) #10885

@haifengkao

Description

@haifengkao

Report

CocoaPods add .docc files as folders in the Pods.xcodeproj. .docc is folder, but it should be added as a regular source file (like .swift) in Xcode project file for apple's documentation system to work.

The behavior can be observed by comparing the Pods.xcodeproj before and after pod install

What did you do?

  1. Xcode -> File -> New -> Documentation Catalog
  2. put the file inside a local pod classes folder
  3. add hello to the Documentation Catalog file
  4. Xcode -> Product -> Build Documentation
  5. pod install
    Xcode doesn't display hello for the local pod documentation

What did you expect to happen?

  1. Xcode -> File -> New -> Documentation Catalog
  2. put the file inside a local pod classes folder
  3. add hello to the Documentation Catalog file
  4. Xcode -> Product -> Build Documentation

Xcode displays the hello for the local pod documentation successfully if I don't run pod install

What happened instead?

local pod documentation becomes the default landing page after I run pod install

CocoaPods Environment

Stack

   CocoaPods : 1.10.2
        Ruby : ruby 2.6.3p62 (2019-04-16 revision 67580) [universal.x86_64-darwin20]
    RubyGems : 3.0.3
        Host : macOS 11.4 (20F71)
       Xcode : 13.0 (13A5201i)
         Git : git version 2.30.1 (Apple Git-130)
Ruby lib dir : /System/Library/Frameworks/Ruby.framework/Versions/2.6/usr/lib
Repositories : bitbucket-csspecs - git - git@bitbucket.org:howgeli/csspecs.git @ 009803dd8fd961ce13894a7f7ac1f73dfac180e9

               trunk - CDN - https://cdn.cocoapods.org/

Installation Source

Executable Path: /usr/local/bin/pod

Plugins

cocoapods-binary       : 0.4.4
cocoapods-binary-cache : 0.1.14
cocoapods-deintegrate  : 1.0.4
cocoapods-links-v2     : 0.4.0
cocoapods-plugins      : 1.0.0
cocoapods-search       : 1.0.0
cocoapods-stats        : 1.1.0
cocoapods-trunk        : 1.5.0
cocoapods-try          : 1.2.0

Project that demonstrates the issue

The working project which can display hello in the documentation successfully.
https://github.com/haifengkao/DoccDemo

If you run pod install, the hello will disappear.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions