Skip to content

Commit

Permalink
Fixed docs links
Browse files Browse the repository at this point in the history
  • Loading branch information
g-amichnia committed Oct 13, 2021
1 parent d8d59d3 commit 97f7769
Show file tree
Hide file tree
Showing 9 changed files with 82 additions and 82 deletions.
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
[![Platform](https://img.shields.io/cocoapods/p/SwiftyMocky.svg?style=flat)](https://cocoapods.org/pods/SwiftyMocky)
[![Docs](https://cdn.rawgit.com/MakeAWishFoundation/SwiftyMocky/master/docs/badge.svg)](https://cdn.rawgit.com/MakeAWishFoundation/SwiftyMocky/master/docs/index.html)
[![Docs](https://cdn.rawgit.com/MakeAWishFoundation/SwiftyMocky/master/docs/badge.svg)](https://rawcdn.githack.com/MakeAWishFoundation/SwiftyMocky/master/docs/index.html)
[![License](https://img.shields.io/cocoapods/l/SwiftyMocky.svg?style=flat)](https://cocoapods.org/pods/SwiftyMocky)

[![Pods compatible](https://img.shields.io/cocoapods/v/SwiftyMocky.svg?style=flat&color=green)](https://cocoapods.org/pods/SwiftyMocky)
Expand Down Expand Up @@ -385,11 +385,11 @@ SwiftyMocky is available under the MIT license. See the [LICENSE][link-license]

<!-- Links based on tag -->

[link-docs]: https://cdn.rawgit.com/MakeAWishFoundation/SwiftyMocky/4.1.0/docs/index.html
[link-docs-features]: https://cdn.rawgit.com/MakeAWishFoundation/SwiftyMocky/4.1.0/docs/supported-features.html
[link-docs-installation]: https://cdn.rawgit.com/MakeAWishFoundation/SwiftyMocky/4.1.0/docs/installation.html
[link-docs-installation-carthage]: https://cdn.rawgit.com/MakeAWishFoundation/SwiftyMocky/4.1.0/docs/installation.html#installation-carthage
[link-docs-setup]: https://cdn.rawgit.com/MakeAWishFoundation/SwiftyMocky/4.1.0/docs/setup-in-project.html
[link-docs]: https://rawcdn.githack.com/MakeAWishFoundation/SwiftyMocky/4.1.0/docs/index.html
[link-docs-features]: https://rawcdn.githack.com/MakeAWishFoundation/SwiftyMocky/4.1.0/docs/supported-features.html
[link-docs-installation]: https://rawcdn.githack.com/MakeAWishFoundation/SwiftyMocky/4.1.0/docs/installation.html
[link-docs-installation-carthage]: https://rawcdn.githack.com/MakeAWishFoundation/SwiftyMocky/4.1.0/docs/installation.html#installation-carthage
[link-docs-setup]: https://rawcdn.githack.com/MakeAWishFoundation/SwiftyMocky/4.1.0/docs/setup-in-project.html

<!-- Assets -->

Expand Down
14 changes: 7 additions & 7 deletions docs/changelog.html
Original file line number Diff line number Diff line change
Expand Up @@ -285,20 +285,20 @@ <h4 id='added' class='heading'>Added:</h4>

<ul>
<li>moved CLI to main repo (old will be deprecated)</li>
<li>protocol compositions (Ernesto Cambuston)</li>
<li>SwiftLint rules support (Mikhail Igonin)</li>
<li>cli binary in repo</li>
<li>cli: resolving proper Sourcery version and binary path (mint is no longer default, if Pods used)</li>
<li>protocol compositions (@erneestoc Ernesto Cambuston)</li>
<li>SwiftLint rules support (@migonin Mikhail Igonin)</li>
<li>cli binary in the repo</li>
<li>cli: resolving proper Sourcery version and binary path (mint is no longer default if Pods used)</li>
</ul>
<h4 id='fixed' class='heading'>Fixed:</h4>

<ul>
<li>Fixed some concurrency issues</li>
<li>Fixed several matcher and compare issues</li>
<li>Fixed @availability for Swift 5.5</li>
<li>Fixed availability for Swift 5.5</li>
<li>Fixed other basic issues and changes for Sourcery 1.6.0</li>
<li>Fixed observer setup when test is marked as async</li>
<li>Fixed CLI dependencies (Sergey Kovalenko)</li>
<li>Fixed observer setup when the test is marked as async</li>
<li>Fixed CLI dependencies (@SergeyKovalenko Sergey Kovalenko)</li>
<li>Moved tests from travis to github actions</li>
</ul>

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -285,20 +285,20 @@ <h4 id='added' class='heading'>Added:</h4>

<ul>
<li>moved CLI to main repo (old will be deprecated)</li>
<li>protocol compositions (Ernesto Cambuston)</li>
<li>SwiftLint rules support (Mikhail Igonin)</li>
<li>cli binary in repo</li>
<li>cli: resolving proper Sourcery version and binary path (mint is no longer default, if Pods used)</li>
<li>protocol compositions (@erneestoc Ernesto Cambuston)</li>
<li>SwiftLint rules support (@migonin Mikhail Igonin)</li>
<li>cli binary in the repo</li>
<li>cli: resolving proper Sourcery version and binary path (mint is no longer default if Pods used)</li>
</ul>
<h4 id='fixed' class='heading'>Fixed:</h4>

<ul>
<li>Fixed some concurrency issues</li>
<li>Fixed several matcher and compare issues</li>
<li>Fixed @availability for Swift 5.5</li>
<li>Fixed availability for Swift 5.5</li>
<li>Fixed other basic issues and changes for Sourcery 1.6.0</li>
<li>Fixed observer setup when test is marked as async</li>
<li>Fixed CLI dependencies (Sergey Kovalenko)</li>
<li>Fixed observer setup when the test is marked as async</li>
<li>Fixed CLI dependencies (@SergeyKovalenko Sergey Kovalenko)</li>
<li>Moved tests from travis to github actions</li>
</ul>

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -278,7 +278,7 @@
<h1 id='swiftymocky-4-1-0' class='heading'>SwiftyMocky 4.1.0</h1>
<h1 id='img-src-https-raw-githubusercontent-com-makeawishfoundation-swiftymocky-4-1-0-icon-png-alt-logo' class='heading'><img src="https://raw.githubusercontent.com/MakeAWishFoundation/SwiftyMocky/4.1.0/icon.png" alt="logo"></h1>

<p>Check out <a href="https://cdn.rawgit.com/MakeAWishFoundation/SwiftyMocky/4.1.0/docs/contents.html">guides</a>, or full <a href="https://cdn.rawgit.com/MakeAWishFoundation/SwiftyMocky/4.1.0/docs/index.html">documentation</a></p>
<p>Check out <a href="https://rawcdn.githack.com/MakeAWishFoundation/SwiftyMocky/4.1.0/docs/contents.html">guides</a>, or full <a href="https://rawcdn.githack.com/MakeAWishFoundation/SwiftyMocky/4.1.0/docs/index.html">documentation</a></p>
<h2 id='table-of-contents' class='heading'>Table of contents</h2>

<ol>
Expand Down Expand Up @@ -339,7 +339,7 @@ <h2 id='version-4-0-x' class='heading'>Version 4.0.x</h2>

<p><strong>SwiftyPrototype</strong> was also extracted to separate library. There are no more compilation flags, so if you were relying on <strong>SwiftyMocky</strong> with <code>-DMockyCustom</code>, you will have to switch to <code>SwiftyPrototype</code>.</p>

<p>We consider current version as stable. We are moving toward using the new <a href="https://cdn.rawgit.com/MakeAWishFoundation/SwiftyMocky/4.1.0/docs/mockfile.html">Mockfile</a> but the previous configuration format would be still supported. Library works with Swift <strong>4.1, 4.2, 5.0, 5.1.2</strong> and Sourcery 1.0.x.</p>
<p>We consider current version as stable. We are moving toward using the new <a href="https://rawcdn.githack.com/MakeAWishFoundation/SwiftyMocky/4.1.0/docs/mockfile.html">Mockfile</a> but the previous configuration format would be still supported. Library works with Swift <strong>4.1, 4.2, 5.0, 5.1.2</strong> and Sourcery 1.0.x.</p>

<p>While it is technically possible to integrate SwiftyMocky on Linux targets, there is no Mock generation feature there yet. You can use SwiftyMokcy runtime via SwiftPM though, as long as your are fine with generating mocks on mac machine.</p>
<h2 id='migration-from-3-2-0-and-below' class='heading'>Migration from 3.2.0 and below</h2>
Expand Down Expand Up @@ -377,7 +377,7 @@ <h3 id='1-integrating-swiftymocky' class='heading'>1. Integrating SwiftyMocky:</

<p>Then execute <code>carthage update</code></p>

<p>For <a href="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/Carthage/Carthage">Carthage</a>, few additional steps are required ⚠️. For detailed install instructions, see full <a href="https://cdn.rawgit.com/MakeAWishFoundation/SwiftyMocky/4.1.0/docs/installation.html#installation-carthage">documentation</a> or consult [Carthage documentation][carthage-adding-framework].</p>
<p>For <a href="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/Carthage/Carthage">Carthage</a>, few additional steps are required ⚠️. For detailed install instructions, see full <a href="https://rawcdn.githack.com/MakeAWishFoundation/SwiftyMocky/4.1.0/docs/installation.html#installation-carthage">documentation</a> or consult [Carthage documentation][carthage-adding-framework].</p>

<p>You need to install CLI to generate mocks - see <a href="#installation">installation</a></p>

Expand Down Expand Up @@ -418,15 +418,15 @@ <h3 id='3-generate-mocks' class='heading'>3. Generate mocks</h3>

<p><a href="#mock-annotate">Annotate your protocols</a> that are going to be mocked, making them adopt <code>AutoMockable</code> protocol, or adding annotation comment above their definition in the source code.</p>

<p>Mocks are generated from your project root directory, based on configuration inside <a href="https://cdn.rawgit.com/MakeAWishFoundation/SwiftyMocky/4.1.0/docs/mockfile.html">Mockfile</a>.</p>
<p>Mocks are generated from your project root directory, based on configuration inside <a href="https://rawcdn.githack.com/MakeAWishFoundation/SwiftyMocky/4.1.0/docs/mockfile.html">Mockfile</a>.</p>
<pre class="highlight shell"><code><span class="o">&gt;</span> swiftymocky setup <span class="c"># if you don't have a Mockfile yet</span>
<span class="o">&gt;</span> swiftymocky doctor <span class="c"># validate your setup</span>
<span class="o">&gt;</span> swiftymocky generate <span class="c"># generate mocks</span>
</code></pre>

<p>More informations about <a href="https://cdn.rawgit.com/MakeAWishFoundation/SwiftyMocky/4.1.0/docs/command-line-interface.html">CLI</a> and <a href="https://cdn.rawgit.com/MakeAWishFoundation/SwiftyMocky/4.1.0/docs/command-line-interface.html#generate">mock generation</a></p>
<p>More informations about <a href="https://rawcdn.githack.com/MakeAWishFoundation/SwiftyMocky/4.1.0/docs/command-line-interface.html">CLI</a> and <a href="https://rawcdn.githack.com/MakeAWishFoundation/SwiftyMocky/4.1.0/docs/command-line-interface.html#generate">mock generation</a></p>

<p>If you don&rsquo;t want to migrate to our <strong>CLI</strong> and prefer to use <q>raw</q> Sourcery, please refer <a href="https://cdn.rawgit.com/MakeAWishFoundation/SwiftyMocky/4.1.0/docs/legacy.html">to this section in documentation</a>.</p>
<p>If you don&rsquo;t want to migrate to our <strong>CLI</strong> and prefer to use <q>raw</q> Sourcery, please refer <a href="https://rawcdn.githack.com/MakeAWishFoundation/SwiftyMocky/4.1.0/docs/legacy.html">to this section in documentation</a>.</p>

<p><a name="usage"></a></p>
<h1 id='usage' class='heading'>Usage</h1>
Expand Down Expand Up @@ -483,7 +483,7 @@ <h2 id='2-stubbing-return-values-for-mock-methods-strong-given-strong' class='he
<span class="c1">// ...</span>
</code></pre>

<p>For more details please see full <a href="https://cdn.rawgit.com/MakeAWishFoundation/SwiftyMocky/4.1.0/docs/index.html">documentation</a>.</p>
<p>For more details please see full <a href="https://rawcdn.githack.com/MakeAWishFoundation/SwiftyMocky/4.1.0/docs/index.html">documentation</a>.</p>

<p><a name="verify"></a></p>
<h2 id='3-check-invocations-of-methods-subscripts-and-properties-strong-verify-strong' class='heading'>3. Check invocations of methods, subscripts and properties - <strong>Verify</strong></h2>
Expand Down Expand Up @@ -546,21 +546,21 @@ <h3 id='4-take-action-when-a-stubbed-method-is-called-strong-perform-strong' cla
<p><a name="guides"></a></p>
<h1 id='documentation' class='heading'>Documentation</h1>

<p>Full documentation is available <a href="https://cdn.rawgit.com/MakeAWishFoundation/SwiftyMocky/4.1.0/docs/index.html">here</a>, as well as through <em>docs</em> directory.</p>
<p>Full documentation is available <a href="https://rawcdn.githack.com/MakeAWishFoundation/SwiftyMocky/4.1.0/docs/index.html">here</a>, as well as through <em>docs</em> directory.</p>

<p>Guides - <a href="https://cdn.rawgit.com/MakeAWishFoundation/SwiftyMocky/4.1.0/docs/contents.html">Table of contents</a></p>
<p>Guides - <a href="https://rawcdn.githack.com/MakeAWishFoundation/SwiftyMocky/4.1.0/docs/contents.html">Table of contents</a></p>

<p>Changelog is available <a href="https://cdn.rawgit.com/MakeAWishFoundation/SwiftyMocky/4.1.0/docs/changelog.html">here</a></p>
<p>Changelog is available <a href="https://rawcdn.githack.com/MakeAWishFoundation/SwiftyMocky/4.1.0/docs/changelog.html">here</a></p>

<p><a name="features"></a></p>
<h2 id='all-supported-features' class='heading'>All supported features</h2>

<p>For list all supported features, check documentation <a href="https://cdn.rawgit.com/MakeAWishFoundation/SwiftyMocky/4.1.0/docs/supported-features.html">here</a> or [guides][link-guides-features]</p>
<p>For list all supported features, check documentation <a href="https://rawcdn.githack.com/MakeAWishFoundation/SwiftyMocky/4.1.0/docs/supported-features.html">here</a> or [guides][link-guides-features]</p>

<p><a name="examples"></a></p>
<h2 id='examples-of-usage' class='heading'>Examples of usage</h2>

<p>For more examples, check out our example project, or examples section in <a href="https://cdn.rawgit.com/MakeAWishFoundation/SwiftyMocky/4.1.0/docs/examples.html">guides</a>.</p>
<p>For more examples, check out our example project, or examples section in <a href="https://rawcdn.githack.com/MakeAWishFoundation/SwiftyMocky/4.1.0/docs/examples.html">guides</a>.</p>

<p>To run the example project, clone the repo, and run <code>pod install</code> from the Example directory first.</p>

Expand Down
Loading

0 comments on commit 97f7769

Please sign in to comment.