Skip to content

Commit

Permalink
Revert docc related changes from "Migrate from xcworkspace to swift p…
Browse files Browse the repository at this point in the history
…ackage (#119)"

This reverts the docc related changes in commit 5f01bdc.
  • Loading branch information
tgymnich committed Jul 2, 2024
1 parent 881a7f8 commit f310ca1
Show file tree
Hide file tree
Showing 1,013 changed files with 20,944 additions and 1,397 deletions.
27 changes: 0 additions & 27 deletions .github/workflows/docs.yml

This file was deleted.

29 changes: 29 additions & 0 deletions .github/workflows/jazzy.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
name: Swift

on:
push:
tags:
- '*'

jobs:
macos:
runs-on: macos-latest
steps:
- uses: actions/checkout@v2
- name: Install jazzy
run: gem install jazzy
- name: Generate documentation
run: |
jazzy \
--clean \
--github-file-prefix "https://github.com/attaswift/$module/tree/${GITHUB_REF}" \
--module-version "${{ github.event.release.tag_name }}" \
--copyright "© $(date '+%Y') [Károly Lőrentey](https://twitter.com/lorentey). (Last updated: $(date '+%Y-%m-%d'))" \
--config .jazzy.yml
- 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
8 changes: 8 additions & 0 deletions .jazzy.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
module: BigInt
author: Károly Lőrentey
theme: fullwidth
output: ./docs
author_url: "https://twitter.com/lorentey"
github_url: "https://github.com/attaswift/BigInt"
root_url: "https://attaswift.github.io/BigInt/reference/"
xcodebuild_arguments: ["-workspace", "BigInt.xcworkspace", "-scheme", "BigInt-macOS"]
2 changes: 1 addition & 1 deletion .spi.yml
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
version: 1
external_links:
documentation: "https://attaswift.github.io/BigInt/documentation/bigint/"
documentation: "https://attaswift.github.io/BigInt/"
42 changes: 28 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@ in it.

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

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

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

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

[license]: https://github.com/attaswift/BigInt/blob/master/LICENSE.md
[twitter]: https://twitter.com/lorentey
[BigInt]: https://attaswift.github.io/BigInt/documentation/bigint/bigint
[BigUInt]: https://attaswift.github.io/BigInt/documentation/bigint/biguint
[hashing]: https://attaswift.github.io/BigInt/documentation/bigint/bigint/hashable-implementations
[addition]: https://attaswift.github.io/BigInt/documentation/bigint/bigint/additivearithmetic-implementations
[mul]: https://attaswift.github.io/BigInt/documentation/bigint/biguint/multiplied(by:)
[width]: https://attaswift.github.io/BigInt/documentation/bigint/bigint/bitwidth
[leadingZeroBitCount]: https://attaswift.github.io/BigInt/documentation/bigint/biguint/leadingzerobitcount
[trailingZeroBitCount]: https://attaswift.github.io/BigInt/documentation/bigint/bigint/trailingzerobitcount
[BigUInt]: http://attaswift.github.io/BigInt/Structs/BigUInt.html
[BigInt]: http://attaswift.github.io/BigInt/Structs/BigInt.html
[comparison]: http://attaswift.github.io/BigInt/Structs/BigUInt.html#/Comparison
[hashing]: http://attaswift.github.io/BigInt/Structs/BigUInt.html#/Hashing
[addition]: http://attaswift.github.io/BigInt/Structs/BigUInt.html#/Addition
[subtraction]: http://attaswift.github.io/BigInt/Structs/BigUInt.html#/Subtraction
[mul]: http://attaswift.github.io/BigInt/Structs/BigUInt.html#/s:ZFV6BigInt7BigUIntoi1mFTS0_S0__S0_
[fused]: http://attaswift.github.io/BigInt/Structs/BigUInt.html#/s:FV6BigInt7BigUInt14multiplyAndAddFTS0_Vs6UInt6410atPositionSi_T_
[multiplication]: http://attaswift.github.io/BigInt/Structs/BigUInt.html#/Multiplication
[division]: http://attaswift.github.io/BigInt/Structs/BigUInt.html#/Division
[divide]: http://attaswift.github.io/BigInt/Structs/BigUInt.html#/s:FV6BigInt7BigUInt7dividedFT2byS0__T8quotientS0_9remainderS0__
[bitwise]: http://attaswift.github.io/BigInt/Structs/BigUInt.html#/Bitwise%20Operations
[width]: http://attaswift.github.io/BigInt/Structs/BigUInt.html#/s:vV6BigInt7BigUInt5widthSi
[leadingZeroBitCount]: http://attaswift.github.io/BigInt/Structs/BigUInt.html#/s:vV6BigInt7BigUInt13leadingZeroBitCountSi
[trailingZeroBitCount]: http://attaswift.github.io/BigInt/Structs/BigUInt.html#/s:vV6BigInt7BigUInt14trailingZeroBitCountSi
[shift]: http://attaswift.github.io/BigInt/Structs/BigUInt.html#/Shift%20Operators
[data]: http://attaswift.github.io/BigInt/Structs/BigUInt.html#/NSData%20Conversion
[random]: http://attaswift.github.io/BigInt/Structs/BigUInt.html#/Random%20Integers
[radix1]: http://attaswift.github.io/BigInt/Extensions/String.html#/s:FE6BigIntSScFTVS_7BigUInt5radixSi9uppercaseSb_SS
[radix2]: http://attaswift.github.io/BigInt/Structs/BigUInt.html#/s:FV6BigInt7BigUIntcFTSS5radixSi_GSqS0__
[sqrt]: http://attaswift.github.io/BigInt/Functions.html#/s:F6BigInt4sqrtFVS_7BigUIntS0_
[GCD]: https://attaswift.github.io/BigInt/documentation/bigint/bigint/greatestcommondivisor(with:)
[powmod]: https://attaswift.github.io/BigInt/documentation/bigint/bigint/power(_:modulus:)
[power]: https://attaswift.github.io/BigInt/documentation/bigint/bigint/power(_:)
[inverse]: https://attaswift.github.io/BigInt/documentation/bigint/bigint/inverse(_:)
[prime]: https://attaswift.github.io/BigInt/documentation/bigint/bigint/isprime(rounds:)
[GCD]: http://attaswift.github.io/BigInt/Structs/BigUInt.html#/s:ZFV6BigInt7BigUInt3gcdFTS0_S0__S0_
[powmod]: http://attaswift.github.io/BigInt/Structs/BigUInt.html#/s:FV6BigInt7BigUInt5powerFTS0_7modulusS0__S0_
[power]: http://attaswift.github.io/BigInt/Structs/BigUInt.html#/s:FV6BigInt7BigUInt5powerFSiS0_
[inverse]: http://attaswift.github.io/BigInt/Structs/BigUInt.html#/s:FV6BigInt7BigUInt7inverseFS0_GSqS0__
[prime]: http://attaswift.github.io/BigInt/Structs/BigUInt.html#/Primality%20Testing
[abs]: http://attaswift.github.io/BigInt/Structs/BigInt.html#/s:vV6BigInt6BigInt3absVS_7BigUInt
[negative]: http://attaswift.github.io/BigInt/Structs/BigInt.html#/s:vV6BigInt6BigInt8negativeSb
[subscript]: https://github.com/attaswift/BigInt/blob/v2.0.0/Sources/BigUInt.swift#L216-L239
[fullmuldiv]: https://github.com/attaswift/BigInt/blob/v2.0.0/Sources/BigDigit.swift#L96-L167

Expand Down
173 changes: 173 additions & 0 deletions docs/Extensions.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,173 @@
<!DOCTYPE html>
<html lang="en">
<head>
<title>Extensions Reference</title>
<link rel="stylesheet" type="text/css" href="css/jazzy.css" />
<link rel="stylesheet" type="text/css" href="css/highlight.css" />
<meta charset="utf-8">
<script src="js/jquery.min.js" defer></script>
<script src="js/jazzy.js" defer></script>

<script src="js/lunr.min.js" defer></script>
<script src="js/typeahead.jquery.js" defer></script>
<script src="js/jazzy.search.js" defer></script>
</head>
<body>

<a name="//apple_ref/swift/Section/Extensions" class="dashAnchor"></a>

<a title="Extensions Reference"></a>

<header class="header">
<p class="header-col header-col--primary">
<a class="header-link" href="index.html">
BigInt Docs
</a>
(85% documented)
</p>

<p class="header-col--secondary">
<form role="search" action="search.json">
<input type="text" placeholder="Search documentation" data-typeahead>
</form>
</p>

<p class="header-col header-col--secondary">
<a class="header-link" href="https://github.com/attaswift/BigInt">
<img class="header-icon" src="img/gh.png"/>
View on GitHub
</a>
</p>

<p class="header-col header-col--secondary">
<a class="header-link" href="dash-feed://https%3A%2F%2Fattaswift.github.io%2FBigInt%2Freference%2Fdocsets%2FBigInt.xml">
<img class="header-icon" src="img/dash.png"/>
Install in Dash
</a>
</p>
</header>

<p class="breadcrumbs">
<a class="breadcrumb" href="index.html">BigInt Reference</a>
<img class="carat" src="img/carat.png" />
Extensions Reference
</p>

<div class="content-wrapper">
<nav class="navigation">
<ul class="nav-groups">
<li class="nav-group-name">
<a class="nav-group-name-link" href="Extensions.html">Extensions</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="Extensions/BinaryFloatingPoint.html">BinaryFloatingPoint</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Extensions/String.html">String</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="Structs.html">Structures</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="Structs/BigInt.html">BigInt</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Structs/BigInt/Sign.html">– Sign</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Structs/BigInt/Words.html">– Words</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Structs/BigUInt.html">BigUInt</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Structs/BigUInt/Words.html">– Words</a>
</li>
</ul>
</li>
</ul>
</nav>
<article class="main-content">

<section class="section">
<div class="section-content top-matter">
<h1>Extensions</h1>
<p>The following extensions are available globally.</p>

</div>
</section>

<section class="section">
<div class="section-content">
<div class="task-group">
<ul class="item-container">
<li class="item">
<div>
<code>
<a name="/s:SB"></a>
<a name="//apple_ref/swift/Extension/BinaryFloatingPoint" class="dashAnchor"></a>
<a class="token" href="#/s:SB">BinaryFloatingPoint</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">

<a href="Extensions/BinaryFloatingPoint.html" class="slightly-smaller">See more</a>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<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>

</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:SS"></a>
<a name="//apple_ref/swift/Extension/String" class="dashAnchor"></a>
<a class="token" href="#/s:SS">String</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">

<a href="Extensions/String.html" class="slightly-smaller">See more</a>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">extension</span> <span class="kt">String</span></code></pre>

</div>
</div>
</section>
</div>
</li>
</ul>
</div>
</div>
</section>

</article>
</div>
<section class="footer">
<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>
<p>Generated by <a class="link" href="https://github.com/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>
</section>
</body>
</div>
</html>
Loading

0 comments on commit f310ca1

Please sign in to comment.