Skip to content

Commit

Permalink
docs: update documentation (#89)
Browse files Browse the repository at this point in the history
Update documentation by running `yarn build:docs`.
  • Loading branch information
marcelosalloum authored Jun 10, 2022
1 parent c7c9e74 commit 11bf82c
Show file tree
Hide file tree
Showing 20 changed files with 1,197 additions and 638 deletions.
2 changes: 1 addition & 1 deletion @stellar/anchor-tests/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@
"husky": "^6.0.0",
"prettier": "^2.2.1",
"pretty-quick": "^3.1.0",
"typedoc": "^0.20.36",
"typedoc": "^0.21.0",
"typescript": "^4.2.4"
},
"dependencies": {
Expand Down
2 changes: 1 addition & 1 deletion docs/assets/js/search.js

Large diffs are not rendered by default.

166 changes: 82 additions & 84 deletions docs/classes/configerror.html

Large diffs are not rendered by default.

38 changes: 22 additions & 16 deletions docs/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -128,55 +128,61 @@ <h3>Library</h3>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
<li class=" tsd-kind-class">
<a href="classes/configerror.html" class="tsd-kind-icon">Config<wbr>Error</a>
<a href="classes/ConfigError.html" class="tsd-kind-icon">Config<wbr>Error</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/config.html" class="tsd-kind-icon">Config</a>
<a href="interfaces/Config.html" class="tsd-kind-icon">Config</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/context.html" class="tsd-kind-icon">Context</a>
<a href="interfaces/Context.html" class="tsd-kind-icon">Context</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/failure.html" class="tsd-kind-icon">Failure</a>
<a href="interfaces/DependenciesCaller.html" class="tsd-kind-icon">Dependencies<wbr>Caller</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/networkcall.html" class="tsd-kind-icon">Network<wbr>Call</a>
<a href="interfaces/Failure.html" class="tsd-kind-icon">Failure</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/result.html" class="tsd-kind-icon">Result</a>
<a href="interfaces/NetworkCall.html" class="tsd-kind-icon">Network<wbr>Call</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/sep12config.html" class="tsd-kind-icon">Sep12<wbr>Config</a>
<a href="interfaces/Result.html" class="tsd-kind-icon">Result</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/sep31config.html" class="tsd-kind-icon">Sep31<wbr>Config</a>
<a href="interfaces/Sep12Config.html" class="tsd-kind-icon">Sep12<wbr>Config</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/sep6config.html" class="tsd-kind-icon">Sep6<wbr>Config</a>
<a href="interfaces/Sep31Config.html" class="tsd-kind-icon">Sep31<wbr>Config</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/sepconfig.html" class="tsd-kind-icon">Sep<wbr>Config</a>
<a href="interfaces/Sep38Config.html" class="tsd-kind-icon">Sep38<wbr>Config</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/stats.html" class="tsd-kind-icon">Stats</a>
<a href="interfaces/Sep6Config.html" class="tsd-kind-icon">Sep6<wbr>Config</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/test.html" class="tsd-kind-icon">Test</a>
<a href="interfaces/SepConfig.html" class="tsd-kind-icon">Sep<wbr>Config</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/testrun.html" class="tsd-kind-icon">Test<wbr>Run</a>
<a href="interfaces/Stats.html" class="tsd-kind-icon">Stats</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/Test.html" class="tsd-kind-icon">Test</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/TestRun.html" class="tsd-kind-icon">Test<wbr>Run</a>
</li>
<li class=" tsd-kind-type-alias">
<a href="modules.html#sep" class="tsd-kind-icon">SEP</a>
<a href="modules.html#SEP" class="tsd-kind-icon">SEP</a>
</li>
<li class=" tsd-kind-function">
<a href="modules.html#gettests" class="tsd-kind-icon">get<wbr>Tests</a>
<a href="modules.html#getTests" class="tsd-kind-icon">get<wbr>Tests</a>
</li>
<li class=" tsd-kind-function">
<a href="modules.html#run" class="tsd-kind-icon">run</a>
</li>
<li class=" tsd-kind-function">
<a href="modules.html#runtests" class="tsd-kind-icon">run<wbr>Tests</a>
<a href="modules.html#runTests" class="tsd-kind-icon">run<wbr>Tests</a>
</li>
</ul>
</nav>
Expand Down
192 changes: 192 additions & 0 deletions docs/interfaces/DependenciesCaller.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,192 @@
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>DependenciesCaller | Stellar Anchor Tests</title>
<meta name="description" content="Documentation for Stellar Anchor Tests">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
<script async src="../assets/js/search.js" id="search-script"></script>
</head>
<body>
<header>
<div class="tsd-page-toolbar">
<div class="container">
<div class="table-wrap">
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
<div class="field">
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
<input id="tsd-search-field" type="text" />
</div>
<ul class="results">
<li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li>
</ul>
<a href="../index.html" class="title">Stellar Anchor Tests</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
<div class="tsd-filter-group">
<div class="tsd-select" id="tsd-filter-visibility">
<span class="tsd-select-label">All</span>
<ul class="tsd-select-list">
<li data-value="public">Public</li>
<li data-value="protected">Public/Protected</li>
<li data-value="private" class="selected">All</li>
</ul>
</div>
<input type="checkbox" id="tsd-filter-inherited" checked />
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
<input type="checkbox" id="tsd-filter-externals" checked />
<label class="tsd-widget" for="tsd-filter-externals">Externals</label>
</div>
</div>
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
</div>
</div>
</div>
</div>
<div class="tsd-page-title">
<div class="container">
<ul class="tsd-breadcrumb">
<li>
<a href="../modules.html">Stellar Anchor Tests</a>
</li>
<li>
<a href="DependenciesCaller.html">DependenciesCaller</a>
</li>
</ul>
<h1>Interface DependenciesCaller</h1>
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<span class="target">DependenciesCaller</span>
</li>
</ul>
</section>
<section class="tsd-panel">
<h3 class="tsd-before-signature">Callable</h3>
<ul class="tsd-signatures tsd-kind-interface">
<li class="tsd-signature tsd-kind-icon">Dependencies<wbr>Caller<span class="tsd-signature-symbol">(</span>config<span class="tsd-signature-symbol">: </span><a href="Config.html" class="tsd-signature-type" data-tsd-kind="Interface">Config</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="Test.html" class="tsd-signature-type" data-tsd-kind="Interface">Test</a><span class="tsd-signature-symbol">[]</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in @stellar/anchor-tests/src/types.ts:280</li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>config: <a href="Config.html" class="tsd-signature-type" data-tsd-kind="Interface">Config</a></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="Test.html" class="tsd-signature-type" data-tsd-kind="Interface">Test</a><span class="tsd-signature-symbol">[]</span></h4>
</li>
</ul>
</section>
</div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<nav class="tsd-navigation primary">
<ul>
<li class=" ">
<a href="../modules.html">Exports</a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
<li class=" tsd-kind-class">
<a href="../classes/ConfigError.html" class="tsd-kind-icon">Config<wbr>Error</a>
</li>
<li class=" tsd-kind-interface">
<a href="Config.html" class="tsd-kind-icon">Config</a>
</li>
<li class=" tsd-kind-interface">
<a href="Context.html" class="tsd-kind-icon">Context</a>
</li>
</ul>
<ul class="current">
<li class="current tsd-kind-interface">
<a href="DependenciesCaller.html" class="tsd-kind-icon">Dependencies<wbr>Caller</a>
</li>
</ul>
<ul class="after-current">
<li class=" tsd-kind-interface">
<a href="Failure.html" class="tsd-kind-icon">Failure</a>
</li>
<li class=" tsd-kind-interface">
<a href="NetworkCall.html" class="tsd-kind-icon">Network<wbr>Call</a>
</li>
<li class=" tsd-kind-interface">
<a href="Result.html" class="tsd-kind-icon">Result</a>
</li>
<li class=" tsd-kind-interface">
<a href="Sep12Config.html" class="tsd-kind-icon">Sep12<wbr>Config</a>
</li>
<li class=" tsd-kind-interface">
<a href="Sep31Config.html" class="tsd-kind-icon">Sep31<wbr>Config</a>
</li>
<li class=" tsd-kind-interface">
<a href="Sep38Config.html" class="tsd-kind-icon">Sep38<wbr>Config</a>
</li>
<li class=" tsd-kind-interface">
<a href="Sep6Config.html" class="tsd-kind-icon">Sep6<wbr>Config</a>
</li>
<li class=" tsd-kind-interface">
<a href="SepConfig.html" class="tsd-kind-icon">Sep<wbr>Config</a>
</li>
<li class=" tsd-kind-interface">
<a href="Stats.html" class="tsd-kind-icon">Stats</a>
</li>
<li class=" tsd-kind-interface">
<a href="Test.html" class="tsd-kind-icon">Test</a>
</li>
<li class=" tsd-kind-interface">
<a href="TestRun.html" class="tsd-kind-icon">Test<wbr>Run</a>
</li>
<li class=" tsd-kind-type-alias">
<a href="../modules.html#SEP" class="tsd-kind-icon">SEP</a>
</li>
<li class=" tsd-kind-function">
<a href="../modules.html#getTests" class="tsd-kind-icon">get<wbr>Tests</a>
</li>
<li class=" tsd-kind-function">
<a href="../modules.html#run" class="tsd-kind-icon">run</a>
</li>
<li class=" tsd-kind-function">
<a href="../modules.html#runTests" class="tsd-kind-icon">run<wbr>Tests</a>
</li>
</ul>
</nav>
</div>
</div>
</div>
<footer>
<div class="container">
<h2>Legend</h2>
<div class="tsd-legend-group">
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
<li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
</ul>
</div>
</div>
</footer>
<div class="overlay"></div>
<script src="../assets/js/main.js"></script>
</body>
</html>
Loading

0 comments on commit 11bf82c

Please sign in to comment.