Skip to content
This repository has been archived by the owner on Aug 5, 2024. It is now read-only.

Commit

Permalink
Deployed 59c754f with MkDocs version: 1.5.3
Browse files Browse the repository at this point in the history
  • Loading branch information
rsavoye committed Dec 10, 2023
1 parent 8df7a79 commit 5670120
Show file tree
Hide file tree
Showing 16 changed files with 3,214 additions and 2,194 deletions.
21 changes: 20 additions & 1 deletion 404.html
Original file line number Diff line number Diff line change
Expand Up @@ -426,7 +426,26 @@


<span class="md-ellipsis">
API
Code API
</span>


</a>
</li>








<li class="md-nav__item">
<a href="/protos-api/" class="md-nav__link">


<span class="md-ellipsis">
Protobuf API
</span>


Expand Down
21 changes: 20 additions & 1 deletion CHANGELOG/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -435,7 +435,26 @@


<span class="md-ellipsis">
API
Code API
</span>


</a>
</li>








<li class="md-nav__item">
<a href="../protos-api/" class="md-nav__link">


<span class="md-ellipsis">
Protobuf API
</span>


Expand Down
23 changes: 21 additions & 2 deletions LICENSE/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
<link rel="canonical" href="https://www.hotosm.org/LICENSE/">


<link rel="prev" href="../api/">
<link rel="prev" href="../protos-api/">


<link rel="next" href="../CHANGELOG/">
Expand Down Expand Up @@ -437,7 +437,26 @@


<span class="md-ellipsis">
API
Code API
</span>


</a>
</li>








<li class="md-nav__item">
<a href="../protos-api/" class="md-nav__link">


<span class="md-ellipsis">
Protobuf API
</span>


Expand Down
21 changes: 20 additions & 1 deletion about/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -512,7 +512,26 @@


<span class="md-ellipsis">
API
Code API
</span>


</a>
</li>








<li class="md-nav__item">
<a href="../protos-api/" class="md-nav__link">


<span class="md-ellipsis">
Protobuf API
</span>


Expand Down
39 changes: 29 additions & 10 deletions api/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -16,15 +16,15 @@
<link rel="prev" href="../dataflow/">


<link rel="next" href="../LICENSE/">
<link rel="next" href="../protos-api/">


<link rel="icon" href="../images/favicon.png">
<meta name="generator" content="mkdocs-1.5.3, mkdocs-material-9.4.8">



<title>API - tm-admin</title>
<title>Code API - tm-admin</title>



Expand Down Expand Up @@ -114,7 +114,7 @@
<div class="md-header__topic" data-md-component="header-topic">
<span class="md-ellipsis">

API
Code API

</span>
</div>
Expand Down Expand Up @@ -446,7 +446,7 @@


<span class="md-ellipsis">
API
Code API
</span>


Expand All @@ -457,7 +457,7 @@


<span class="md-ellipsis">
API
Code API
</span>


Expand Down Expand Up @@ -879,6 +879,25 @@



<li class="md-nav__item">
<a href="../protos-api/" class="md-nav__link">


<span class="md-ellipsis">
Protobuf API
</span>


</a>
</li>








<li class="md-nav__item">
<a href="../LICENSE/" class="md-nav__link">

Expand Down Expand Up @@ -3032,7 +3051,7 @@ <h2 id="tm_admin.generator.Generator" class="doc doc-heading">
</thead>
<tbody>
<tr>
<td><code>filespec(</code></td>
<td><code>filespec</code></td>
<td>
<code>str</code>
</td>
Expand All @@ -3042,7 +3061,7 @@ <h2 id="tm_admin.generator.Generator" class="doc doc-heading">
</div>
</td>
<td>
<em>required</em>
<code>None</code>
</td>
</tr>
</tbody>
Expand Down Expand Up @@ -3117,7 +3136,7 @@ <h2 id="tm_admin.generator.Generator" class="doc doc-heading">
<span class="sd"> A class that generates the output files from the config data.</span>

<span class="sd"> Args:</span>
<span class="sd"> filespec( str): The config file to use as source.</span>
<span class="sd"> filespec (str): The config file to use as source.</span>

<span class="sd"> Returns:</span>
<span class="sd"> (Generator): An instance of this class</span>
Expand Down Expand Up @@ -3194,7 +3213,7 @@ <h3 id="tm_admin.generator.Generator.readConfig" class="doc doc-heading">
</thead>
<tbody>
<tr>
<td><code>filespec(</code></td>
<td><code>filespec</code></td>
<td>
<code>str</code>
</td>
Expand Down Expand Up @@ -3229,7 +3248,7 @@ <h3 id="tm_admin.generator.Generator.readConfig" class="doc doc-heading">
<span class="sd"> Reads in the YAML config file.</span>

<span class="sd"> Args:</span>
<span class="sd"> filespec( str): The config file to use as source.</span>
<span class="sd"> filespec (str): The config file to use as source.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="bp">self</span><span class="o">.</span><span class="n">filespec</span> <span class="o">=</span> <span class="n">Path</span><span class="p">(</span><span class="n">filespec</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">yaml</span> <span class="o">=</span> <span class="n">YamlFile</span><span class="p">(</span><span class="n">filespec</span><span class="p">)</span>
Expand Down
23 changes: 21 additions & 2 deletions build/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -516,7 +516,26 @@


<span class="md-ellipsis">
API
Code API
</span>


</a>
</li>








<li class="md-nav__item">
<a href="../protos-api/" class="md-nav__link">


<span class="md-ellipsis">
Protobuf API
</span>


Expand Down Expand Up @@ -691,7 +710,7 @@ <h2 id="yaml-files">.yaml files<a class="headerlink" href="#yaml-files" title="P
output formats. In the case of this projects, that's SQL files for a
local postgres database, protobuf files for gRPC, and python source
files for data type definitions. There is more information on the
<a href="configuring">configuration files here</a></p>
<a href="../configuring/">configuration files here</a></p>
<h2 id="proto-files">.proto files<a class="headerlink" href="#proto-files" title="Permanent link">&para;</a></h2>
<p>These define the messages used by gRPC, and are also generated from
the configuration files. Not every column in the database tables is in
Expand Down
23 changes: 21 additions & 2 deletions communication/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -561,7 +561,26 @@


<span class="md-ellipsis">
API
Code API
</span>


</a>
</li>








<li class="md-nav__item">
<a href="../protos-api/" class="md-nav__link">


<span class="md-ellipsis">
Protobuf API
</span>


Expand Down Expand Up @@ -747,7 +766,7 @@ <h1 id="inter-project-communication">Inter Project Communication<a class="header
be in multiple places. Each data structure is represented in the
database schemas, python, and gRPC. To reduce future maintainance
headaches, a single configuration file is used to generate multiple
output formats. More information on that process is <a href="configuring">documented
output formats. More information on that process is <a href="../configuring/">documented
here</a>.</p>
<p>All communication is bi-directional. Projects can send data, or handle
a request for data. For any data that is sent, the response is a
Expand Down
21 changes: 20 additions & 1 deletion configuring/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -449,7 +449,26 @@


<span class="md-ellipsis">
API
Code API
</span>


</a>
</li>








<li class="md-nav__item">
<a href="../protos-api/" class="md-nav__link">


<span class="md-ellipsis">
Protobuf API
</span>


Expand Down
21 changes: 20 additions & 1 deletion dataflow/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -542,7 +542,26 @@


<span class="md-ellipsis">
API
Code API
</span>


</a>
</li>








<li class="md-nav__item">
<a href="../protos-api/" class="md-nav__link">


<span class="md-ellipsis">
Protobuf API
</span>


Expand Down
21 changes: 20 additions & 1 deletion index.html
Original file line number Diff line number Diff line change
Expand Up @@ -433,7 +433,26 @@


<span class="md-ellipsis">
API
Code API
</span>


</a>
</li>








<li class="md-nav__item">
<a href="protos-api/" class="md-nav__link">


<span class="md-ellipsis">
Protobuf API
</span>


Expand Down
Loading

0 comments on commit 5670120

Please sign in to comment.