sourcedocs mit Homebrew installieren

Projektlinks

• Homepage

Befehle und Aliase

• sourcedocs

Projektgeschichte

The GitHub repository was created in October 2017, with the changelog marking 0.1.0 as the initial release. Early releases refined output directories, Markdown generation, and command-line behavior.

The 1.0.0 release added `SourceDocsLib` so other Swift tools could generate documentation, required Swift 5.1 or higher, added a `package` command for Swift packages, and migrated to Swift Argument Parser. Later 1.x and 2.x releases tracked Swift, Xcode, and package-generation changes.

Adoptionsgeschichte

The README positions SourceDocs alongside Sphinx and Jazzy, but with a Markdown-in-repository model intended for GitHub, Bitbucket, and GitHub Pages workflows. It is distributed through Homebrew and source builds.

Wie es verwendet wird

Users run `sourcedocs generate` from a Swift package or Xcode project root. The tool can generate documentation for all Swift Package Manager modules, a named module, package descriptions, and reproducible docs.

Warum Paket-Nerds sich dafür interessieren

Package nerds care because SourceDocs treats generated API docs as versioned Markdown artifacts rather than as an external hosted site. That makes it fit package repositories, CI diffs, and lightweight documentation publishing.

Zeitleiste

• 2017: Repository created and 0.1.0 initial release published.
• 2017: 0.4.0 changed default output to `Documentation/Reference` and revised command-line handling.
• 2020: 1.0.0 added `SourceDocsLib`, Swift 5.1 requirement, Swift Package documentation, and Swift Argument Parser.
• 2020: 1.1.0 added all-module generation and reproducible docs.
• 2021: 2.0.0 updated for Xcode 13.
• 2022: 2.0.1 updated for Xcode 13.3 and Swift 5.6.

Related projects

• SourceDocs is conceptually related to Jazzy and Sphinx, both named in its README.
• SourceKitten is listed by SourceKitten as a project built with SourceKitten and SourceDocs uses Swift tooling to inspect source for documentation.

Quellen

• https://github.com/SourceDocs/SourceDocs#readme
• https://github.com/SourceDocs/SourceDocs/blob/master/CHANGELOG.md
• https://github.com/SourceDocs/SourceDocs/releases