Skip to content

Commit a17d101

Browse files
am-kantoxwarp-agent
andcommitted
docs: Rebuild API reference documentation
Regenerate API reference and documentation site using rebar3 ex_doc. Updates all documentation output in docs/_build/ with latest compiler and module documentation. Co-Authored-By: Warp <agent@warp.dev>
1 parent b93dc7e commit a17d101

File tree

116 files changed

+962
-7254
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

116 files changed

+962
-7254
lines changed

site/api/.build

Lines changed: 99 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,99 @@
1+
404.html
2+
api-reference.html
3+
api_reference.html
4+
cli_usage.html
5+
cure_action_compiler.html
6+
cure_ast.html
7+
cure_beam_compiler.html
8+
cure_cli.html
9+
cure_codegen.html
10+
cure_compile_wrapper.html
11+
cure_dependent_parser.html
12+
cure_dependent_types.html
13+
cure_derive.html
14+
cure_error_reporter.html
15+
cure_fsm_action_compiler.html
16+
cure_fsm_builtins.html
17+
cure_fsm_cure_api.html
18+
cure_fsm_monitor.html
19+
cure_fsm_runtime.html
20+
cure_fsm_typesafety.html
21+
cure_fsm_verifier.html
22+
cure_guard_codegen.html
23+
cure_guard_compiler.html
24+
cure_guard_optimizer.html
25+
cure_guard_refinement.html
26+
cure_guard_smt.html
27+
cure_instance_registry.html
28+
cure_lexer.html
29+
cure_lsp_code_actions.html
30+
cure_lsp_diagnostics.html
31+
cure_lsp_performance.html
32+
cure_lsp_server.html
33+
cure_lsp_smt.html
34+
cure_lsp_type_holes.html
35+
cure_parser.html
36+
cure_pattern_checker.html
37+
cure_pattern_encoder.html
38+
cure_pipe_optimizer.html
39+
cure_profiler.html
40+
cure_refinement_types.html
41+
cure_runtime.html
42+
cure_show_native.html
43+
cure_signature_generator.html
44+
cure_smt_array.html
45+
cure_smt_parser.html
46+
cure_smt_process.html
47+
cure_smt_solver.html
48+
cure_smt_translator.html
49+
cure_std.html
50+
cure_stdlib_signatures.html
51+
cure_string_native.html
52+
cure_syntax_guide.html
53+
cure_type_optimizer.html
54+
cure_typechecker.html
55+
cure_typeclass.html
56+
cure_typeclass_codegen.html
57+
cure_typeclass_dispatch.html
58+
cure_types.html
59+
cure_ultimate_description.html
60+
cure_utils.html
61+
dist/handlebars.runtime-NWIB6V2M.js
62+
dist/handlebars.templates-K7URE6B4.js
63+
dist/html-PVRIOB7F.js
64+
dist/html-erlang-4IXSOGMD.css
65+
dist/inconsolata-latin-400-normal-RGKDDNDD.woff2
66+
dist/inconsolata-latin-700-normal-DTS2D7TO.woff2
67+
dist/inconsolata-latin-ext-400-normal-K7HVGTP7.woff2
68+
dist/inconsolata-latin-ext-700-normal-4MPBLFZC.woff2
69+
dist/inconsolata-vietnamese-400-normal-IGQPHHJH.woff2
70+
dist/inconsolata-vietnamese-700-normal-LHEGSN35.woff2
71+
dist/lato-latin-300-normal-YUMVEFOL.woff2
72+
dist/lato-latin-400-normal-W7754I4D.woff2
73+
dist/lato-latin-700-normal-2XVSBPG4.woff2
74+
dist/lato-latin-ext-300-normal-VPGGJKJL.woff2
75+
dist/lato-latin-ext-400-normal-N27NCBWW.woff2
76+
dist/lato-latin-ext-700-normal-Q2L5DVMW.woff2
77+
dist/remixicon-NKANDIL5.woff2
78+
dist/search_data-5144F3E2.js
79+
dist/sidebar_items-AA658F96.js
80+
editor_setup.html
81+
feature_reference.html
82+
fsm_api_design.html
83+
fsm_usage.html
84+
function_types.html
85+
index.html
86+
language_spec.html
87+
lexer_error_format.html
88+
lsp_smt_user_guide.html
89+
mcp_integration.html
90+
pipe_operator.html
91+
project_overview.html
92+
readme.html
93+
search.html
94+
smt_quick_reference.html
95+
smt_solver_installation.html
96+
std_summary.html
97+
type_system.html
98+
why_cure.html
99+
why_smt.html

site/api/404.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@
1616

1717
<script src="dist/handlebars.runtime-NWIB6V2M.js"></script>
1818
<script src="dist/handlebars.templates-K7URE6B4.js"></script>
19-
<script src="dist/sidebar_items-C51205A4.js"></script>
19+
<script src="dist/sidebar_items-AA658F96.js"></script>
2020
<script src="docs_config.js"></script>
2121
<script async src="dist/html-PVRIOB7F.js"></script>
2222

site/api/api-reference.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414

1515
<script src="dist/handlebars.runtime-NWIB6V2M.js"></script>
1616
<script src="dist/handlebars.templates-K7URE6B4.js"></script>
17-
<script src="dist/sidebar_items-C51205A4.js"></script>
17+
<script src="dist/sidebar_items-AA658F96.js"></script>
1818
<script src="docs_config.js"></script>
1919
<script async src="dist/html-PVRIOB7F.js"></script>
2020

site/api/api_reference.html

Lines changed: 59 additions & 59 deletions
Large diffs are not rendered by default.

site/api/cli_usage.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414

1515
<script src="dist/handlebars.runtime-NWIB6V2M.js"></script>
1616
<script src="dist/handlebars.templates-K7URE6B4.js"></script>
17-
<script src="dist/sidebar_items-C51205A4.js"></script>
17+
<script src="dist/sidebar_items-AA658F96.js"></script>
1818
<script src="docs_config.js"></script>
1919
<script async src="dist/html-PVRIOB7F.js"></script>
2020

site/api/cure.epub

-3.08 KB
Binary file not shown.

site/api/cure_action_compiler.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414

1515
<script src="dist/handlebars.runtime-NWIB6V2M.js"></script>
1616
<script src="dist/handlebars.templates-K7URE6B4.js"></script>
17-
<script src="dist/sidebar_items-C51205A4.js"></script>
17+
<script src="dist/sidebar_items-AA658F96.js"></script>
1818
<script src="docs_config.js"></script>
1919
<script async src="dist/html-PVRIOB7F.js"></script>
2020

site/api/cure_ast.html

Lines changed: 21 additions & 21 deletions
Large diffs are not rendered by default.

site/api/cure_beam_compiler.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414

1515
<script src="dist/handlebars.runtime-NWIB6V2M.js"></script>
1616
<script src="dist/handlebars.templates-K7URE6B4.js"></script>
17-
<script src="dist/sidebar_items-C51205A4.js"></script>
17+
<script src="dist/sidebar_items-AA658F96.js"></script>
1818
<script src="docs_config.js"></script>
1919
<script async src="dist/html-PVRIOB7F.js"></script>
2020

site/api/cure_cli.html

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414

1515
<script src="dist/handlebars.runtime-NWIB6V2M.js"></script>
1616
<script src="dist/handlebars.templates-K7URE6B4.js"></script>
17-
<script src="dist/sidebar_items-C51205A4.js"></script>
17+
<script src="dist/sidebar_items-AA658F96.js"></script>
1818
<script src="docs_config.js"></script>
1919
<script async src="dist/html-PVRIOB7F.js"></script>
2020

@@ -430,7 +430,7 @@ <h1 class="signature" translate="no">compile_file(Filename)</h1>
430430
</a>
431431
<span class="text">Examples</span>
432432
</h2>
433-
<pre><code class="makeup erlang" translate="no"><span class="nf">compile_file</span><span class="p" data-group-id="0385121597-1">(</span><span class="s">&quot;examples/hello.cure&quot;</span><span class="p" data-group-id="0385121597-1">)</span><span class="p">.</span><span class="w">
433+
<pre><code class="makeup erlang" translate="no"><span class="nf">compile_file</span><span class="p" data-group-id="3508029104-1">(</span><span class="s">&quot;examples/hello.cure&quot;</span><span class="p" data-group-id="3508029104-1">)</span><span class="p">.</span><span class="w">
434434
</span><span class="c1">% =&gt; {ok, &quot;_build/ebin/hello.beam&quot;}</span></code></pre>
435435
</section>
436436
</section>
@@ -477,16 +477,16 @@ <h1 class="signature" translate="no">compile_file(Filename, Options)</h1>
477477
<span class="text">Examples</span>
478478
</h2>
479479
<pre><code class="makeup erlang" translate="no"><span class="c1">% Compile with verbose output</span><span class="w">
480-
</span><span class="n">Options</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="o">#</span><span class="ss">compile_options</span><span class="p" data-group-id="5361668861-1">{</span><span class="ss">verbose</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="ss">true</span><span class="p" data-group-id="5361668861-1">}</span><span class="p">,</span><span class="w">
481-
</span><span class="nf">compile_file</span><span class="p" data-group-id="5361668861-2">(</span><span class="s">&quot;src/math.cure&quot;</span><span class="p">,</span><span class="w"> </span><span class="n">Options</span><span class="p" data-group-id="5361668861-2">)</span><span class="p">.</span><span class="w">
480+
</span><span class="n">Options</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="o">#</span><span class="ss">compile_options</span><span class="p" data-group-id="6528215175-1">{</span><span class="ss">verbose</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="ss">true</span><span class="p" data-group-id="6528215175-1">}</span><span class="p">,</span><span class="w">
481+
</span><span class="nf">compile_file</span><span class="p" data-group-id="6528215175-2">(</span><span class="s">&quot;src/math.cure&quot;</span><span class="p">,</span><span class="w"> </span><span class="n">Options</span><span class="p" data-group-id="6528215175-2">)</span><span class="p">.</span><span class="w">
482482

483483
</span><span class="c1">% Compile without optimizations </span><span class="w">
484-
</span><span class="n">Options</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="o">#</span><span class="ss">compile_options</span><span class="p" data-group-id="5361668861-3">{</span><span class="ss">optimize</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="ss">false</span><span class="p" data-group-id="5361668861-3">}</span><span class="p">,</span><span class="w">
485-
</span><span class="nf">compile_file</span><span class="p" data-group-id="5361668861-4">(</span><span class="s">&quot;debug.cure&quot;</span><span class="p">,</span><span class="w"> </span><span class="n">Options</span><span class="p" data-group-id="5361668861-4">)</span><span class="p">.</span><span class="w">
484+
</span><span class="n">Options</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="o">#</span><span class="ss">compile_options</span><span class="p" data-group-id="6528215175-3">{</span><span class="ss">optimize</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="ss">false</span><span class="p" data-group-id="6528215175-3">}</span><span class="p">,</span><span class="w">
485+
</span><span class="nf">compile_file</span><span class="p" data-group-id="6528215175-4">(</span><span class="s">&quot;debug.cure&quot;</span><span class="p">,</span><span class="w"> </span><span class="n">Options</span><span class="p" data-group-id="6528215175-4">)</span><span class="p">.</span><span class="w">
486486

487487
</span><span class="c1">% Custom output file</span><span class="w">
488-
</span><span class="n">Options</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="o">#</span><span class="ss">compile_options</span><span class="p" data-group-id="5361668861-5">{</span><span class="ss">output_file</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;custom.beam&quot;</span><span class="p" data-group-id="5361668861-5">}</span><span class="p">,</span><span class="w">
489-
</span><span class="nf">compile_file</span><span class="p" data-group-id="5361668861-6">(</span><span class="s">&quot;input.cure&quot;</span><span class="p">,</span><span class="w"> </span><span class="n">Options</span><span class="p" data-group-id="5361668861-6">)</span><span class="p">.</span></code></pre>
488+
</span><span class="n">Options</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="o">#</span><span class="ss">compile_options</span><span class="p" data-group-id="6528215175-5">{</span><span class="ss">output_file</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;custom.beam&quot;</span><span class="p" data-group-id="6528215175-5">}</span><span class="p">,</span><span class="w">
489+
</span><span class="nf">compile_file</span><span class="p" data-group-id="6528215175-6">(</span><span class="s">&quot;input.cure&quot;</span><span class="p">,</span><span class="w"> </span><span class="n">Options</span><span class="p" data-group-id="6528215175-6">)</span><span class="p">.</span></code></pre>
490490
</section>
491491
</section>
492492
<section class="detail" id="compile_file_from_shell/1">
@@ -682,8 +682,8 @@ <h1 class="signature" translate="no">get_module_info/1</h1>
682682
</a>
683683
<span class="text">Example</span>
684684
</h2>
685-
<pre><code class="makeup erlang" translate="no"><span class="n">AST</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nc">cure_parser</span><span class="p">:</span><span class="nf">parse_file</span><span class="p" data-group-id="0414722227-1">(</span><span class="s">&quot;MyModule.cure&quot;</span><span class="p" data-group-id="0414722227-1">)</span><span class="p">,</span><span class="w">
686-
</span><span class="n">Info</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nf">get_module_info</span><span class="p" data-group-id="0414722227-2">(</span><span class="n">AST</span><span class="p" data-group-id="0414722227-2">)</span><span class="p">,</span><span class="w">
685+
<pre><code class="makeup erlang" translate="no"><span class="n">AST</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nc">cure_parser</span><span class="p">:</span><span class="nf">parse_file</span><span class="p" data-group-id="8949626931-1">(</span><span class="s">&quot;MyModule.cure&quot;</span><span class="p" data-group-id="8949626931-1">)</span><span class="p">,</span><span class="w">
686+
</span><span class="n">Info</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nf">get_module_info</span><span class="p" data-group-id="8949626931-2">(</span><span class="n">AST</span><span class="p" data-group-id="8949626931-2">)</span><span class="p">,</span><span class="w">
687687
</span><span class="c1">% =&gt; #{name =&gt; &#39;MyModule&#39;, exports =&gt; [{hello, 1}], ...}</span></code></pre>
688688
</section>
689689
</section>
@@ -772,9 +772,9 @@ <h1 class="signature" translate="no">main(Args)</h1>
772772
<span class="text">Examples</span>
773773
</h2>
774774
<pre><code class="makeup erlang" translate="no"><span class="c1">% These calls happen automatically when using the CLI:</span><span class="w">
775-
</span><span class="nf">main</span><span class="p" data-group-id="9066731106-1">(</span><span class="p" data-group-id="9066731106-2">[</span><span class="s">&quot;input.cure&quot;</span><span class="p" data-group-id="9066731106-2">]</span><span class="p" data-group-id="9066731106-1">)</span><span class="p">.</span><span class="w">
776-
</span><span class="nf">main</span><span class="p" data-group-id="9066731106-3">(</span><span class="p" data-group-id="9066731106-4">[</span><span class="s">&quot;input.cure&quot;</span><span class="p">,</span><span class="w"> </span><span class="s">&quot;-o&quot;</span><span class="p">,</span><span class="w"> </span><span class="s">&quot;output.beam&quot;</span><span class="p" data-group-id="9066731106-4">]</span><span class="p" data-group-id="9066731106-3">)</span><span class="p">.</span><span class="w">
777-
</span><span class="nf">main</span><span class="p" data-group-id="9066731106-5">(</span><span class="p" data-group-id="9066731106-6">[</span><span class="s">&quot;--help&quot;</span><span class="p" data-group-id="9066731106-6">]</span><span class="p" data-group-id="9066731106-5">)</span><span class="p">.</span></code></pre><h2 id="main/1-error-handling" class="section-heading">
775+
</span><span class="nf">main</span><span class="p" data-group-id="5167625163-1">(</span><span class="p" data-group-id="5167625163-2">[</span><span class="s">&quot;input.cure&quot;</span><span class="p" data-group-id="5167625163-2">]</span><span class="p" data-group-id="5167625163-1">)</span><span class="p">.</span><span class="w">
776+
</span><span class="nf">main</span><span class="p" data-group-id="5167625163-3">(</span><span class="p" data-group-id="5167625163-4">[</span><span class="s">&quot;input.cure&quot;</span><span class="p">,</span><span class="w"> </span><span class="s">&quot;-o&quot;</span><span class="p">,</span><span class="w"> </span><span class="s">&quot;output.beam&quot;</span><span class="p" data-group-id="5167625163-4">]</span><span class="p" data-group-id="5167625163-3">)</span><span class="p">.</span><span class="w">
777+
</span><span class="nf">main</span><span class="p" data-group-id="5167625163-5">(</span><span class="p" data-group-id="5167625163-6">[</span><span class="s">&quot;--help&quot;</span><span class="p" data-group-id="5167625163-6">]</span><span class="p" data-group-id="5167625163-5">)</span><span class="p">.</span></code></pre><h2 id="main/1-error-handling" class="section-heading">
778778
<a href="#main/1-error-handling" class="hover-link">
779779
<i class="ri-link-m" aria-hidden="true"></i>
780780
</a>

0 commit comments

Comments
 (0)