Skip to content

Commit

Permalink
use docc
Browse files Browse the repository at this point in the history
  • Loading branch information
tgymnich committed Jun 26, 2024
1 parent 02a6ac5 commit 9cb4fba
Show file tree
Hide file tree
Showing 1,027 changed files with 1,382 additions and 20,916 deletions.
26 changes: 26 additions & 0 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
name: Docs

on:
push:
tags:
- '*'

jobs:
macos:
runs-on: macos-latest
steps:
- uses: actions/checkout@v4
- name: Generate documentation
run: |
swift package --allow-writing-to-directory docs generate-documentation \
--target BigInt \
--disable-indexing \
--output-path docs \
--transform-for-static-hosting
- name: Commit docs
run: |
git config --local user.email "[email protected]"
git config --local user.name "GitHub Actions"
git add ./docs
git commit -m "Update docs"
git push origin HEAD:master
29 changes: 0 additions & 29 deletions .github/workflows/jazzy.yml

This file was deleted.

8 changes: 0 additions & 8 deletions .jazzy.yml

This file was deleted.

3 changes: 3 additions & 0 deletions Package.swift
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,9 @@ let package = Package(
],
products: [
.library(name: "BigInt", targets: ["BigInt"])
],
dependencies: [
.package(url: "https://github.com/apple/swift-docc-plugin", from: "1.0.0"),
],
targets: [
.target(name: "BigInt", path: "Sources"),
Expand Down
2 changes: 1 addition & 1 deletion Sources/Multiplication.swift
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ extension BigUInt {
///
/// - Note: This is the fused multiply/shift/add operation; it is more efficient than doing the components
/// individually. (The fused operation doesn't need to allocate space for temporary big integers.)
/// - Returns: `self` is set to `self + (x * y) << (shift * 2^Word.bitWidth)`
/// `self` is set to `self + (x * y) << (shift * 2^Word.bitWidth)`
/// - Complexity: O(count)
public mutating func multiplyAndAdd(_ x: BigUInt, _ y: Word, shiftedBy shift: Int = 0) {
precondition(shift >= 0)
Expand Down
173 changes: 0 additions & 173 deletions docs/Extensions.html

This file was deleted.

Loading

0 comments on commit 9cb4fba

Please sign in to comment.