Skip to content

Commit

Permalink
chore&doc: update documentation generation
Browse files Browse the repository at this point in the history
  • Loading branch information
rockmagma02 committed Jun 28, 2024
1 parent b1de42e commit f620fec
Show file tree
Hide file tree
Showing 3 changed files with 4 additions and 13 deletions.
11 changes: 1 addition & 10 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -64,16 +64,7 @@ clean-dist:
# Documentation

doc: init-swift
swift package --allow-writing-to-directory ./Documentation-StreamUtilities generate-documentation --target StreamUtilities --output-path ./Documentation-StreamUtilities --transform-for-static-hosting
swift package --allow-writing-to-directory ./Documentation-SyncStream generate-documentation --target SyncStream --output-path ./Documentation-SyncStream --transform-for-static-hosting
swift package --allow-writing-to-directory ./Documentation-BidirectionalStream generate-documentation --target BidirectionalStream --output-path ./Documentation-BidirectionalStream --transform-for-static-hosting
mkdir Documentation
cp -r Documentation-StreamUtilities/* Documentation
cp -r Documentation-SyncStream/* Documentation
cp -r Documentation-BidirectionalStream/* Documentation
rm -rf Documentation-StreamUtilities
rm -rf Documentation-SyncStream
rm -rf Documentation-BidirectionalStream
swift package --allow-writing-to-directory ./Documentation generate-documentation-multitarget --main-target $(PROJECT_NAME) --target SyncStream --target BidirectionalStream --output ./Documentation

# Tools Installation
pre-commit-install:
Expand Down
2 changes: 1 addition & 1 deletion Package.swift
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ let package = Package(
),
],
dependencies: [
.package(url: "https://github.com/apple/swift-docc-plugin", branch: "main"),
.package(url: "https://github.com/rockmagma02/swift-docc-plugin", branch: "main"),
],
targets: [
// Targets are the basic building blocks of a package, defining a module or a test suite.
Expand Down
4 changes: 2 additions & 2 deletions Sources/StreamUtilities/StreamUtilities.docc/LandingPage.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,8 @@

## Documentation

+ [SyncStream](./SyncStream)
+ [BidirectionalStream](./BidirectionalStream)
+ [SyncStream](../syncstream)
+ [BidirectionalStream](../bidirectionalstream)

## Getting Started

Expand Down

0 comments on commit f620fec

Please sign in to comment.