jpsim / jpsim/SourceKitten

Building docs for multiple modules in xcodeproj

Open
#628 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Swift
Stars
2.4k
Forks
237
PR merge metrics
No merged PRs in 30d

Description

Hi!

I'm using sourcekitten to generate docs for a project with multiple modules. However, the vast majority of modules depend on a couple similar modules. Is there a way to run the build to re-use the previously built dependencies? Maybe the xcodebuild options could change to not do a clean.

For example:

modules

Foo
Bar
Baz

dependencies

Bar:

  • Foo

Baz:
-Foo

I want to generate docs for all 3 modules but don't want to rebuild Foo for each module

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 tracing the xcodebuild invocation used when generating documentation for multiple modules. Reproduce the Foo, Bar, and Baz dependency layout and check whether build options can preserve and reuse previously built dependencies. Done means documentation generation avoids rebuilding Foo for each dependent module.

Written by the indexing model from the issue text.

Assessment

Tech stack
swift
Domain
build-system, documentation
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.