Skip to content

Commit

Permalink
📝 Updated documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
@ronaldokun
ronaldokun committed Aug 10, 2024
1 parent 56d9595 commit a902594
Show file tree
Hide file tree
Showing 12 changed files with 925 additions and 557 deletions.
443 changes: 285 additions & 158 deletions README.md
View file

Large diffs are not rendered by default.

11 changes: 2 additions & 9 deletions _docs/datatypes.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -189,14 +189,12 @@ <h1 class="title">Datatypes</h1>

<!-- WARNING: THIS FILE WAS AUTOGENERATED! DO NOT EDIT! -->
<hr>
<p><a href="https://github.com/InovaFiscaliza/fiscaliza/blob/main/fiscaliza/datatypes.py#L23" target="_blank" style="float:right; font-size:smaller">source</a></p>
<section id="atomicfield" class="level3">
<h3 class="anchored" data-anchor-id="atomicfield">AtomicField</h3>
<blockquote class="blockquote">
<pre><code> AtomicField (name:str, keyword:str, mandatory:bool=True)</code></pre>
</blockquote>
<hr>
<p><a href="https://github.com/InovaFiscaliza/fiscaliza/blob/main/fiscaliza/datatypes.py#L47" target="_blank" style="float:right; font-size:smaller">source</a></p>
</section>
<section id="simplefield" class="level3">
<h3 class="anchored" data-anchor-id="simplefield">SimpleField</h3>
Expand All @@ -205,7 +203,6 @@ <h3 class="anchored" data-anchor-id="simplefield">SimpleField</h3>
format_value:bool=False, _dtype:str='string')</code></pre>
</blockquote>
<hr>
<p><a href="https://github.com/InovaFiscaliza/fiscaliza/blob/main/fiscaliza/datatypes.py#L112" target="_blank" style="float:right; font-size:smaller">source</a></p>
</section>
<section id="encodedstring" class="level3">
<h3 class="anchored" data-anchor-id="encodedstring">EncodedString</h3>
Expand All @@ -216,7 +213,6 @@ <h3 class="anchored" data-anchor-id="encodedstring">EncodedString</h3>
</blockquote>
<p><em>This class always format the value string The json key is called ‘numero’</em></p>
<hr>
<p><a href="https://github.com/InovaFiscaliza/fiscaliza/blob/main/fiscaliza/datatypes.py#L133" target="_blank" style="float:right; font-size:smaller">source</a></p>
</section>
<section id="fieldwithoptions" class="level3">
<h3 class="anchored" data-anchor-id="fieldwithoptions">FieldWithOptions</h3>
Expand All @@ -227,21 +223,18 @@ <h3 class="anchored" data-anchor-id="fieldwithoptions">FieldWithOptions</h3>
mapping:dict[str,list]=None)</code></pre>
</blockquote>
<hr>
<p><a href="https://github.com/InovaFiscaliza/fiscaliza/blob/main/fiscaliza/datatypes.py#L181" target="_blank" style="float:right; font-size:smaller">source</a></p>
</section>
<section id="coordenadas" class="level3">
<h3 class="anchored" data-anchor-id="coordenadas">Coordenadas</h3>
<blockquote class="blockquote">
<pre><code> Coordenadas (id:int, name:str, mandatory:bool=False,
value:tuple[str|float]|None=None)</code></pre>
<pre><code> Coordenadas (id:int, name:str, mandatory:bool=False)</code></pre>
</blockquote>
<hr>
<p><a href="https://github.com/InovaFiscaliza/fiscaliza/blob/main/fiscaliza/datatypes.py#L213" target="_blank" style="float:right; font-size:smaller">source</a></p>
</section>
<section id="gerarplai" class="level3">
<h3 class="anchored" data-anchor-id="gerarplai">GerarPlai</h3>
<blockquote class="blockquote">
<pre><code> GerarPlai (id:int, name:str, mandatory:bool=False, value:tuple|None=None)</code></pre>
<pre><code> GerarPlai (id:int, name:str, mandatory:bool=False)</code></pre>
</blockquote>


Expand Down
454 changes: 292 additions & 162 deletions _docs/index.html
View file

Large diffs are not rendered by default.

2 changes: 0 additions & 2 deletions _docs/main.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -185,15 +185,13 @@ <h1 class="title">Main</h1>

<!-- WARNING: THIS FILE WAS AUTOGENERATED! DO NOT EDIT! -->
<hr>
<p><a href="https://github.com/InovaFiscaliza/fiscaliza/blob/main/fiscaliza/main.py#L33" target="_blank" style="float:right; font-size:smaller">source</a></p>
<section id="fiscaliza" class="level3">
<h3 class="anchored" data-anchor-id="fiscaliza">Fiscaliza</h3>
<blockquote class="blockquote">
<pre><code> Fiscaliza (username:str, password:str, teste:bool=True, key:str=None)</code></pre>
</blockquote>
<p><em>Initialize self. See help(type(self)) for accurate signature.</em></p>
<hr>
<p><a href="https://github.com/InovaFiscaliza/fiscaliza/blob/main/fiscaliza/main.py#L76" target="_blank" style="float:right; font-size:smaller">source</a></p>
</section>
<section id="issue" class="level3">
<h3 class="anchored" data-anchor-id="issue">Issue</h3>
Expand Down
14 changes: 7 additions & 7 deletions _docs/search.json
View file

Large diffs are not rendered by default.

10 changes: 5 additions & 5 deletions _docs/sitemap.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,22 +2,22 @@
<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
<url>
<loc>https://InovaFiscaliza.github.io/fiscaliza/index.html</loc>
<lastmod>2024-07-26T05:01:07.160Z</lastmod>
<lastmod>2024-08-10T01:54:29.330Z</lastmod>
</url>
<url>
<loc>https://InovaFiscaliza.github.io/fiscaliza/attrs.html</loc>
<lastmod>2024-07-26T05:01:07.160Z</lastmod>
<lastmod>2024-08-10T01:54:29.340Z</lastmod>
</url>
<url>
<loc>https://InovaFiscaliza.github.io/fiscaliza/datatypes.html</loc>
<lastmod>2024-07-26T05:01:07.150Z</lastmod>
<lastmod>2024-08-10T01:54:29.350Z</lastmod>
</url>
<url>
<loc>https://InovaFiscaliza.github.io/fiscaliza/constants.html</loc>
<lastmod>2024-07-26T05:01:07.210Z</lastmod>
<lastmod>2024-08-10T01:54:29.380Z</lastmod>
</url>
<url>
<loc>https://InovaFiscaliza.github.io/fiscaliza/main.html</loc>
<lastmod>2024-07-26T05:39:52.540Z</lastmod>
<lastmod>2024-08-10T01:54:29.420Z</lastmod>
</url>
</urlset>
8 changes: 0 additions & 8 deletions _proc/00_main.ipynb
View file
Original file line number Diff line number Diff line change
Expand Up @@ -31,8 +31,6 @@
"text/markdown": [
"---\n",
"\n",
"[source](https://github.com/InovaFiscaliza/fiscaliza/blob/main/fiscaliza/main.py#L33){target=\"_blank\" style=\"float:right; font-size:smaller\"}\n",
"\n",
"### Fiscaliza\n",
"\n",
"> Fiscaliza (username:str, password:str, teste:bool=True, key:str=None)\n",
Expand All @@ -42,8 +40,6 @@
"text/plain": [
"---\n",
"\n",
"[source](https://github.com/InovaFiscaliza/fiscaliza/blob/main/fiscaliza/main.py#L33){target=\"_blank\" style=\"float:right; font-size:smaller\"}\n",
"\n",
"### Fiscaliza\n",
"\n",
"> Fiscaliza (username:str, password:str, teste:bool=True, key:str=None)\n",
Expand Down Expand Up @@ -73,8 +69,6 @@
"text/markdown": [
"---\n",
"\n",
"[source](https://github.com/InovaFiscaliza/fiscaliza/blob/main/fiscaliza/main.py#L76){target=\"_blank\" style=\"float:right; font-size:smaller\"}\n",
"\n",
"### Issue\n",
"\n",
"> Issue (client:redminelib.Redmine, issue_id:int|str)\n",
Expand All @@ -84,8 +78,6 @@
"text/plain": [
"---\n",
"\n",
"[source](https://github.com/InovaFiscaliza/fiscaliza/blob/main/fiscaliza/main.py#L76){target=\"_blank\" style=\"float:right; font-size:smaller\"}\n",
"\n",
"### Issue\n",
"\n",
"> Issue (client:redminelib.Redmine, issue_id:int|str)\n",
Expand Down
34 changes: 4 additions & 30 deletions _proc/02_datatypes.ipynb
View file
Original file line number Diff line number Diff line change
Expand Up @@ -32,17 +32,13 @@
"text/markdown": [
"---\n",
"\n",
"[source](https://github.com/InovaFiscaliza/fiscaliza/blob/main/fiscaliza/datatypes.py#L23){target=\"_blank\" style=\"float:right; font-size:smaller\"}\n",
"\n",
"### AtomicField\n",
"\n",
"> AtomicField (name:str, keyword:str, mandatory:bool=True)"
],
"text/plain": [
"---\n",
"\n",
"[source](https://github.com/InovaFiscaliza/fiscaliza/blob/main/fiscaliza/datatypes.py#L23){target=\"_blank\" style=\"float:right; font-size:smaller\"}\n",
"\n",
"### AtomicField\n",
"\n",
"> AtomicField (name:str, keyword:str, mandatory:bool=True)"
Expand Down Expand Up @@ -70,8 +66,6 @@
"text/markdown": [
"---\n",
"\n",
"[source](https://github.com/InovaFiscaliza/fiscaliza/blob/main/fiscaliza/datatypes.py#L47){target=\"_blank\" style=\"float:right; font-size:smaller\"}\n",
"\n",
"### SimpleField\n",
"\n",
"> SimpleField (id:int, name:str, mandatory:bool=False, multiple:bool=False,\n",
Expand All @@ -80,8 +74,6 @@
"text/plain": [
"---\n",
"\n",
"[source](https://github.com/InovaFiscaliza/fiscaliza/blob/main/fiscaliza/datatypes.py#L47){target=\"_blank\" style=\"float:right; font-size:smaller\"}\n",
"\n",
"### SimpleField\n",
"\n",
"> SimpleField (id:int, name:str, mandatory:bool=False, multiple:bool=False,\n",
Expand Down Expand Up @@ -110,8 +102,6 @@
"text/markdown": [
"---\n",
"\n",
"[source](https://github.com/InovaFiscaliza/fiscaliza/blob/main/fiscaliza/datatypes.py#L112){target=\"_blank\" style=\"float:right; font-size:smaller\"}\n",
"\n",
"### EncodedString\n",
"\n",
"> EncodedString (id:int, name:str, mandatory:bool=False,\n",
Expand All @@ -124,8 +114,6 @@
"text/plain": [
"---\n",
"\n",
"[source](https://github.com/InovaFiscaliza/fiscaliza/blob/main/fiscaliza/datatypes.py#L112){target=\"_blank\" style=\"float:right; font-size:smaller\"}\n",
"\n",
"### EncodedString\n",
"\n",
"> EncodedString (id:int, name:str, mandatory:bool=False,\n",
Expand Down Expand Up @@ -158,8 +146,6 @@
"text/markdown": [
"---\n",
"\n",
"[source](https://github.com/InovaFiscaliza/fiscaliza/blob/main/fiscaliza/datatypes.py#L133){target=\"_blank\" style=\"float:right; font-size:smaller\"}\n",
"\n",
"### FieldWithOptions\n",
"\n",
"> FieldWithOptions (id:int, name:str, mandatory:bool=False,\n",
Expand All @@ -170,8 +156,6 @@
"text/plain": [
"---\n",
"\n",
"[source](https://github.com/InovaFiscaliza/fiscaliza/blob/main/fiscaliza/datatypes.py#L133){target=\"_blank\" style=\"float:right; font-size:smaller\"}\n",
"\n",
"### FieldWithOptions\n",
"\n",
"> FieldWithOptions (id:int, name:str, mandatory:bool=False,\n",
Expand Down Expand Up @@ -202,22 +186,16 @@
"text/markdown": [
"---\n",
"\n",
"[source](https://github.com/InovaFiscaliza/fiscaliza/blob/main/fiscaliza/datatypes.py#L181){target=\"_blank\" style=\"float:right; font-size:smaller\"}\n",
"\n",
"### Coordenadas\n",
"\n",
"> Coordenadas (id:int, name:str, mandatory:bool=False,\n",
"> value:tuple[str|float]|None=None)"
"> Coordenadas (id:int, name:str, mandatory:bool=False)"
],
"text/plain": [
"---\n",
"\n",
"[source](https://github.com/InovaFiscaliza/fiscaliza/blob/main/fiscaliza/datatypes.py#L181){target=\"_blank\" style=\"float:right; font-size:smaller\"}\n",
"\n",
"### Coordenadas\n",
"\n",
"> Coordenadas (id:int, name:str, mandatory:bool=False,\n",
"> value:tuple[str|float]|None=None)"
"> Coordenadas (id:int, name:str, mandatory:bool=False)"
]
},
"execution_count": 5,
Expand All @@ -242,20 +220,16 @@
"text/markdown": [
"---\n",
"\n",
"[source](https://github.com/InovaFiscaliza/fiscaliza/blob/main/fiscaliza/datatypes.py#L213){target=\"_blank\" style=\"float:right; font-size:smaller\"}\n",
"\n",
"### GerarPlai\n",
"\n",
"> GerarPlai (id:int, name:str, mandatory:bool=False, value:tuple|None=None)"
"> GerarPlai (id:int, name:str, mandatory:bool=False)"
],
"text/plain": [
"---\n",
"\n",
"[source](https://github.com/InovaFiscaliza/fiscaliza/blob/main/fiscaliza/datatypes.py#L213){target=\"_blank\" style=\"float:right; font-size:smaller\"}\n",
"\n",
"### GerarPlai\n",
"\n",
"> GerarPlai (id:int, name:str, mandatory:bool=False, value:tuple|None=None)"
"> GerarPlai (id:int, name:str, mandatory:bool=False)"
]
},
"execution_count": 6,
Expand Down
Loading

0 comments on commit a902594

Please sign in to comment.