yonaskolb / yonaskolb/XcodeGen

[help wanted] About XcodeGen and DocC

Open
#1,370 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Swift
Stars
8.8k
Forks
908
Avg merge
17d 14h
Merged PRs (30d)
2

Description

Hi guys, I need some assistance with XcodeGen and DocC.
I've been using XcodeGen in my project which has multiple Targets and Schemes.
In this scenario, I'm finding it quite challenging to utilize DocC effectively. For instance, even after adding a Documentation Catalog template to the project and making some alterations, I'm unable to see the modified text content after building the Documentation.

Could you please guide me on how to set up my XcodeGen yml file? Furthermore, considering my project's multiple Targets and Schemes, I'm uncertain about the appropriate location for creating my Documentation Catalog. If you could provide an example or detailed steps, that would be even more helpful. Any guidance or suggestions would be greatly appreciated.

Thank you in advance.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the XcodeGen yml configuration and the Documentation Catalog template in a project with multiple Targets and Schemes. Verify how the documentation is associated with the intended target and confirm that edited text appears after building the Documentation.

Written by the indexing model from the issue text.

Assessment

Tech stack
swift, yaml
Domain
build-system, documentation, tooling
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.