Skip to content

Commit 793a7fa

Browse files
tgymnichtgymnich
committed
Revert docc related changes from "Migrate from xcworkspace to swift package (#119)"
This reverts the docc related changes in commit 5f01bdc.
1 parent 881a7f8 commit 793a7fa

File tree

1,014 files changed

+20944
-1400
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

1,014 files changed

+20944
-1400
lines changed

‎.github/workflows/docs.yml‎

Lines changed: 0 additions & 27 deletions
This file was deleted.

‎.github/workflows/jazzy.yml‎

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
name: Swift
2+
3+
on:
4+
push:
5+
tags:
6+
- '*'
7+
8+
jobs:
9+
macos:
10+
runs-on: macos-latest
11+
steps:
12+
- uses: actions/checkout@v2
13+
- name: Install jazzy
14+
run: gem install jazzy
15+
- name: Generate documentation
16+
run: |
17+
jazzy \
18+
--clean \
19+
--github-file-prefix "https://github.com/attaswift/$module/tree/${GITHUB_REF}" \
20+
--module-version "${{ github.event.release.tag_name }}" \
21+
--copyright "© $(date '+%Y') [Károly Lőrentey](https://twitter.com/lorentey). (Last updated: $(date '+%Y-%m-%d'))" \
22+
--config .jazzy.yml
23+
- name: Commit docs
24+
run: |
25+
git config --local user.email "[email protected]"
26+
git config --local user.name "GitHub Actions"
27+
git add ./docs
28+
git commit -m "Update docs"
29+
git push origin HEAD:master

‎.jazzy.yml‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
module: BigInt
2+
author: Károly Lőrentey
3+
theme: fullwidth
4+
output: ./docs
5+
author_url: "https://twitter.com/lorentey"
6+
github_url: "https://github.com/attaswift/BigInt"
7+
root_url: "https://attaswift.github.io/BigInt/reference/"
8+
xcodebuild_arguments: ["-workspace", "BigInt.xcworkspace", "-scheme", "BigInt-macOS"]

‎.spi.yml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
version: 1
22
external_links:
3-
documentation: "https://attaswift.github.io/BigInt/documentation/bigint/"
3+
documentation: "https://attaswift.github.io/BigInt/"

‎Package.swift‎

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -22,9 +22,6 @@ let package = Package(
2222
products: [
2323
.library(name: "BigInt", targets: ["BigInt"])
2424
],
25-
dependencies: [
26-
.package(url: "https://github.com/apple/swift-docc-plugin", from: "1.0.0"),
27-
],
2825
targets: [
2926
.target(name: "BigInt", path: "Sources"),
3027
.testTarget(name: "BigIntTests", dependencies: ["BigInt"], path: "Tests")

‎README.md‎

Lines changed: 28 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -85,7 +85,7 @@ in it.
8585

8686
## <a name="api">API Documentation</a>
8787

88-
Generated API docs are available at https://attaswift.github.io/BigInt/documentation/bigint/.
88+
Generated API docs are available at https://attaswift.github.io/BigInt/.
8989

9090
## <a name="license">License</a>
9191

@@ -150,20 +150,34 @@ generic variant that was slower but more flexible.
150150

151151
[license]: https://github.com/attaswift/BigInt/blob/master/LICENSE.md
152152
[twitter]: https://twitter.com/lorentey
153-
[BigInt]: https://attaswift.github.io/BigInt/documentation/bigint/bigint
154-
[BigUInt]: https://attaswift.github.io/BigInt/documentation/bigint/biguint
155-
[hashing]: https://attaswift.github.io/BigInt/documentation/bigint/bigint/hashable-implementations
156-
[addition]: https://attaswift.github.io/BigInt/documentation/bigint/bigint/additivearithmetic-implementations
157-
[mul]: https://attaswift.github.io/BigInt/documentation/bigint/biguint/multiplied(by:)
158-
[width]: https://attaswift.github.io/BigInt/documentation/bigint/bigint/bitwidth
159-
[leadingZeroBitCount]: https://attaswift.github.io/BigInt/documentation/bigint/biguint/leadingzerobitcount
160-
[trailingZeroBitCount]: https://attaswift.github.io/BigInt/documentation/bigint/bigint/trailingzerobitcount
153+
[BigUInt]: http://attaswift.github.io/BigInt/Structs/BigUInt.html
154+
[BigInt]: http://attaswift.github.io/BigInt/Structs/BigInt.html
155+
[comparison]: http://attaswift.github.io/BigInt/Structs/BigUInt.html#/Comparison
156+
[hashing]: http://attaswift.github.io/BigInt/Structs/BigUInt.html#/Hashing
157+
[addition]: http://attaswift.github.io/BigInt/Structs/BigUInt.html#/Addition
158+
[subtraction]: http://attaswift.github.io/BigInt/Structs/BigUInt.html#/Subtraction
159+
[mul]: http://attaswift.github.io/BigInt/Structs/BigUInt.html#/s:ZFV6BigInt7BigUIntoi1mFTS0_S0__S0_
160+
[fused]: http://attaswift.github.io/BigInt/Structs/BigUInt.html#/s:FV6BigInt7BigUInt14multiplyAndAddFTS0_Vs6UInt6410atPositionSi_T_
161+
[multiplication]: http://attaswift.github.io/BigInt/Structs/BigUInt.html#/Multiplication
162+
[division]: http://attaswift.github.io/BigInt/Structs/BigUInt.html#/Division
163+
[divide]: http://attaswift.github.io/BigInt/Structs/BigUInt.html#/s:FV6BigInt7BigUInt7dividedFT2byS0__T8quotientS0_9remainderS0__
164+
[bitwise]: http://attaswift.github.io/BigInt/Structs/BigUInt.html#/Bitwise%20Operations
165+
[width]: http://attaswift.github.io/BigInt/Structs/BigUInt.html#/s:vV6BigInt7BigUInt5widthSi
166+
[leadingZeroBitCount]: http://attaswift.github.io/BigInt/Structs/BigUInt.html#/s:vV6BigInt7BigUInt13leadingZeroBitCountSi
167+
[trailingZeroBitCount]: http://attaswift.github.io/BigInt/Structs/BigUInt.html#/s:vV6BigInt7BigUInt14trailingZeroBitCountSi
168+
[shift]: http://attaswift.github.io/BigInt/Structs/BigUInt.html#/Shift%20Operators
169+
[data]: http://attaswift.github.io/BigInt/Structs/BigUInt.html#/NSData%20Conversion
170+
[random]: http://attaswift.github.io/BigInt/Structs/BigUInt.html#/Random%20Integers
171+
[radix1]: http://attaswift.github.io/BigInt/Extensions/String.html#/s:FE6BigIntSScFTVS_7BigUInt5radixSi9uppercaseSb_SS
172+
[radix2]: http://attaswift.github.io/BigInt/Structs/BigUInt.html#/s:FV6BigInt7BigUIntcFTSS5radixSi_GSqS0__
161173
[sqrt]: http://attaswift.github.io/BigInt/Functions.html#/s:F6BigInt4sqrtFVS_7BigUIntS0_
162-
[GCD]: https://attaswift.github.io/BigInt/documentation/bigint/bigint/greatestcommondivisor(with:)
163-
[powmod]: https://attaswift.github.io/BigInt/documentation/bigint/bigint/power(_:modulus:)
164-
[power]: https://attaswift.github.io/BigInt/documentation/bigint/bigint/power(_:)
165-
[inverse]: https://attaswift.github.io/BigInt/documentation/bigint/bigint/inverse(_:)
166-
[prime]: https://attaswift.github.io/BigInt/documentation/bigint/bigint/isprime(rounds:)
174+
[GCD]: http://attaswift.github.io/BigInt/Structs/BigUInt.html#/s:ZFV6BigInt7BigUInt3gcdFTS0_S0__S0_
175+
[powmod]: http://attaswift.github.io/BigInt/Structs/BigUInt.html#/s:FV6BigInt7BigUInt5powerFTS0_7modulusS0__S0_
176+
[power]: http://attaswift.github.io/BigInt/Structs/BigUInt.html#/s:FV6BigInt7BigUInt5powerFSiS0_
177+
[inverse]: http://attaswift.github.io/BigInt/Structs/BigUInt.html#/s:FV6BigInt7BigUInt7inverseFS0_GSqS0__
178+
[prime]: http://attaswift.github.io/BigInt/Structs/BigUInt.html#/Primality%20Testing
179+
[abs]: http://attaswift.github.io/BigInt/Structs/BigInt.html#/s:vV6BigInt6BigInt3absVS_7BigUInt
180+
[negative]: http://attaswift.github.io/BigInt/Structs/BigInt.html#/s:vV6BigInt6BigInt8negativeSb
167181
[subscript]: https://github.com/attaswift/BigInt/blob/v2.0.0/Sources/BigUInt.swift#L216-L239
168182
[fullmuldiv]: https://github.com/attaswift/BigInt/blob/v2.0.0/Sources/BigDigit.swift#L96-L167
169183

‎docs/Extensions.html‎

Lines changed: 173 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,173 @@
1+
<!DOCTYPE html>
2+
<html lang="en">
3+
<head>
4+
<title>Extensions Reference</title>
5+
<link rel="stylesheet" type="text/css" href="css/jazzy.css" />
6+
<link rel="stylesheet" type="text/css" href="css/highlight.css" />
7+
<meta charset="utf-8">
8+
<script src="js/jquery.min.js" defer></script>
9+
<script src="js/jazzy.js" defer></script>
10+
11+
<script src="js/lunr.min.js" defer></script>
12+
<script src="js/typeahead.jquery.js" defer></script>
13+
<script src="js/jazzy.search.js" defer></script>
14+
</head>
15+
<body>
16+
17+
<a name="//apple_ref/swift/Section/Extensions" class="dashAnchor"></a>
18+
19+
<a title="Extensions Reference"></a>
20+
21+
<header class="header">
22+
<p class="header-col header-col--primary">
23+
<a class="header-link" href="index.html">
24+
BigInt Docs
25+
</a>
26+
(85% documented)
27+
</p>
28+
29+
<p class="header-col--secondary">
30+
<form role="search" action="search.json">
31+
<input type="text" placeholder="Search documentation" data-typeahead>
32+
</form>
33+
</p>
34+
35+
<p class="header-col header-col--secondary">
36+
<a class="header-link" href="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/attaswift/BigInt">
37+
<img class="header-icon" src="img/gh.png"/>
38+
View on GitHub
39+
</a>
40+
</p>
41+
42+
<p class="header-col header-col--secondary">
43+
<a class="header-link" href="dash-feed://https%3A%2F%2Fattaswift.github.io%2FBigInt%2Freference%2Fdocsets%2FBigInt.xml">
44+
<img class="header-icon" src="img/dash.png"/>
45+
Install in Dash
46+
</a>
47+
</p>
48+
</header>
49+
50+
<p class="breadcrumbs">
51+
<a class="breadcrumb" href="index.html">BigInt Reference</a>
52+
<img class="carat" src="img/carat.png" />
53+
Extensions Reference
54+
</p>
55+
56+
<div class="content-wrapper">
57+
<nav class="navigation">
58+
<ul class="nav-groups">
59+
<li class="nav-group-name">
60+
<a class="nav-group-name-link" href="Extensions.html">Extensions</a>
61+
<ul class="nav-group-tasks">
62+
<li class="nav-group-task">
63+
<a class="nav-group-task-link" href="Extensions/BinaryFloatingPoint.html">BinaryFloatingPoint</a>
64+
</li>
65+
<li class="nav-group-task">
66+
<a class="nav-group-task-link" href="Extensions/String.html">String</a>
67+
</li>
68+
</ul>
69+
</li>
70+
<li class="nav-group-name">
71+
<a class="nav-group-name-link" href="Structs.html">Structures</a>
72+
<ul class="nav-group-tasks">
73+
<li class="nav-group-task">
74+
<a class="nav-group-task-link" href="Structs/BigInt.html">BigInt</a>
75+
</li>
76+
<li class="nav-group-task">
77+
<a class="nav-group-task-link" href="Structs/BigInt/Sign.html">– Sign</a>
78+
</li>
79+
<li class="nav-group-task">
80+
<a class="nav-group-task-link" href="Structs/BigInt/Words.html">– Words</a>
81+
</li>
82+
<li class="nav-group-task">
83+
<a class="nav-group-task-link" href="Structs/BigUInt.html">BigUInt</a>
84+
</li>
85+
<li class="nav-group-task">
86+
<a class="nav-group-task-link" href="Structs/BigUInt/Words.html">– Words</a>
87+
</li>
88+
</ul>
89+
</li>
90+
</ul>
91+
</nav>
92+
<article class="main-content">
93+
94+
<section class="section">
95+
<div class="section-content top-matter">
96+
<h1>Extensions</h1>
97+
<p>The following extensions are available globally.</p>
98+
99+
</div>
100+
</section>
101+
102+
<section class="section">
103+
<div class="section-content">
104+
<div class="task-group">
105+
<ul class="item-container">
106+
<li class="item">
107+
<div>
108+
<code>
109+
<a name="/s:SB"></a>
110+
<a name="//apple_ref/swift/Extension/BinaryFloatingPoint" class="dashAnchor"></a>
111+
<a class="token" href="#/s:SB">BinaryFloatingPoint</a>
112+
</code>
113+
</div>
114+
<div class="height-container">
115+
<div class="pointer-container"></div>
116+
<section class="section">
117+
<div class="pointer"></div>
118+
<div class="abstract">
119+
120+
<a href="Extensions/BinaryFloatingPoint.html" class="slightly-smaller">See more</a>
121+
</div>
122+
<div class="declaration">
123+
<h4>Declaration</h4>
124+
<div class="language">
125+
<p class="aside-title">Swift</p>
126+
<pre class="highlight swift"><code><span class="kd">extension</span> <span class="kt">BinaryFloatingPoint</span> <span class="k">where</span> <span class="kt">RawExponent</span><span class="p">:</span> <span class="kt">FixedWidthInteger</span><span class="p">,</span> <span class="kt">RawSignificand</span><span class="p">:</span> <span class="kt">FixedWidthInteger</span></code></pre>
127+
128+
</div>
129+
</div>
130+
</section>
131+
</div>
132+
</li>
133+
<li class="item">
134+
<div>
135+
<code>
136+
<a name="/s:SS"></a>
137+
<a name="//apple_ref/swift/Extension/String" class="dashAnchor"></a>
138+
<a class="token" href="#/s:SS">String</a>
139+
</code>
140+
</div>
141+
<div class="height-container">
142+
<div class="pointer-container"></div>
143+
<section class="section">
144+
<div class="pointer"></div>
145+
<div class="abstract">
146+
147+
<a href="Extensions/String.html" class="slightly-smaller">See more</a>
148+
</div>
149+
<div class="declaration">
150+
<h4>Declaration</h4>
151+
<div class="language">
152+
<p class="aside-title">Swift</p>
153+
<pre class="highlight swift"><code><span class="kd">extension</span> <span class="kt">String</span></code></pre>
154+
155+
</div>
156+
</div>
157+
</section>
158+
</div>
159+
</li>
160+
</ul>
161+
</div>
162+
</div>
163+
</section>
164+
165+
</article>
166+
</div>
167+
<section class="footer">
168+
<p>© 2021 <a class="link" href="https://twitter.com/lorentey" target="_blank" rel="noopener" rel="external">Károly Lőrentey</a>. (Last updated: 2021-09-06)</p>
169+
<p>Generated by <a class="link" href="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/realm/jazzy" target="_blank" rel="noopener" rel="external">jazzy ♪♫ v0.14.0</a>, a <a class="link" href="https://realm.io" target="_blank" rel="noopener" rel="external">Realm</a> project.</p>
170+
</section>
171+
</body>
172+
</div>
173+
</html>

0 commit comments

Comments
 (0)