Skip to content

Commit

Permalink
update doc
Browse files Browse the repository at this point in the history
  • Loading branch information
@pthom
pthom committed Dec 14, 2023
1 parent 3c5c106 commit 1ce8be5
Show file tree
Hide file tree
Showing 24 changed files with 995 additions and 980 deletions.
10 changes: 9 additions & 1 deletion docs/index.html
View file
Original file line number Diff line number Diff line change
@@ -1 +1,9 @@
<a href="litgen_book">Litgen book</a>
<!DOCTYPE html>
<html>
<head>
<!-- Redirect to litgen_book/index.html -->
<meta http-equiv="refresh" content="0; url=litgen_book/index.html">
</head>
<body>
</body>
</html>
8 changes: 4 additions & 4 deletions docs/litgen_book/00_00_intro.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -166,7 +166,7 @@
</a>
</li>
</ul>
<p aria-level="2" class="caption" role="heading"><span class="caption-text">Basics</span></p>
<p aria-level="2" class="caption" role="heading"><span class="caption-text">Bindings - Basics</span></p>
<ul class="nav bd-sidenav">
<li class="toctree-l1 has-children"><a class="reference internal" href="01_05_00_install_or_online.html">Installation or online usage</a><input class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-1"><i class="fa-solid fa-chevron-down"></i></label><ul>
<li class="toctree-l2"><a class="reference internal" href="01_05_05_online.html">Use litgen online</a></li>
Expand All @@ -177,7 +177,7 @@
<li class="toctree-l1"><a class="reference internal" href="example_bindings/DaftLib/Readme.html">Generate binding files for a library</a></li>
<li class="toctree-l1"><a class="reference internal" href="01_15_00_cmake_helpers.html">CMake helpers</a></li>
</ul>
<p aria-level="2" class="caption" role="heading"><span class="caption-text">Advanced Topics</span></p>
<p aria-level="2" class="caption" role="heading"><span class="caption-text">Bindings - Advanced Topics</span></p>
<ul class="nav bd-sidenav">
<li class="toctree-l1"><a class="reference internal" href="02_00_00_options.html">litgen options</a></li>
<li class="toctree-l1"><a class="reference internal" href="02_05_00_headers.html">Headers processing</a></li>
Expand Down Expand Up @@ -484,7 +484,7 @@ <h2>Support<a class="headerlink" href="#support" title="Permalink to this headin
<section class="tex2jax_ignore mathjax_ignore" id="table-of-contents">
<h1>Table of contents<a class="headerlink" href="#table-of-contents" title="Permalink to this heading">#</a></h1>
<div class="toctree-wrapper compound">
<p aria-level="2" class="caption" role="heading"><span class="caption-text">Basics</span></p>
<p aria-level="2" class="caption" role="heading"><span class="caption-text">Bindings - Basics</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="01_05_00_install_or_online.html">Installation or online usage</a></li>
<li class="toctree-l1"><a class="reference internal" href="01_10_00_first_steps.html">First steps</a></li>
Expand All @@ -493,7 +493,7 @@ <h1>Table of contents<a class="headerlink" href="#table-of-contents" title="Perm
</ul>
</div>
<div class="toctree-wrapper compound">
<p aria-level="2" class="caption" role="heading"><span class="caption-text">Advanced Topics</span></p>
<p aria-level="2" class="caption" role="heading"><span class="caption-text">Bindings - Advanced Topics</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="02_00_00_options.html">litgen options</a></li>
<li class="toctree-l1"><a class="reference internal" href="02_05_00_headers.html">Headers processing</a></li>
Expand Down
4 changes: 2 additions & 2 deletions docs/litgen_book/01_05_00_install_or_online.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -167,7 +167,7 @@
</a>
</li>
</ul>
<p aria-level="2" class="caption" role="heading"><span class="caption-text">Basics</span></p>
<p aria-level="2" class="caption" role="heading"><span class="caption-text">Bindings - Basics</span></p>
<ul class="current nav bd-sidenav">
<li class="toctree-l1 current active has-children"><a class="current reference internal" href="#">Installation or online usage</a><input checked="" class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-1"><i class="fa-solid fa-chevron-down"></i></label><ul>
<li class="toctree-l2"><a class="reference internal" href="01_05_05_online.html">Use litgen online</a></li>
Expand All @@ -178,7 +178,7 @@
<li class="toctree-l1"><a class="reference internal" href="example_bindings/DaftLib/Readme.html">Generate binding files for a library</a></li>
<li class="toctree-l1"><a class="reference internal" href="01_15_00_cmake_helpers.html">CMake helpers</a></li>
</ul>
<p aria-level="2" class="caption" role="heading"><span class="caption-text">Advanced Topics</span></p>
<p aria-level="2" class="caption" role="heading"><span class="caption-text">Bindings - Advanced Topics</span></p>
<ul class="nav bd-sidenav">
<li class="toctree-l1"><a class="reference internal" href="02_00_00_options.html">litgen options</a></li>
<li class="toctree-l1"><a class="reference internal" href="02_05_00_headers.html">Headers processing</a></li>
Expand Down
60 changes: 30 additions & 30 deletions docs/litgen_book/01_05_05_online.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -167,7 +167,7 @@
</a>
</li>
</ul>
<p aria-level="2" class="caption" role="heading"><span class="caption-text">Basics</span></p>
<p aria-level="2" class="caption" role="heading"><span class="caption-text">Bindings - Basics</span></p>
<ul class="current nav bd-sidenav">
<li class="toctree-l1 current active has-children"><a class="reference internal" href="01_05_00_install_or_online.html">Installation or online usage</a><input checked="" class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-1"><i class="fa-solid fa-chevron-down"></i></label><ul class="current">
<li class="toctree-l2 current active"><a class="current reference internal" href="#">Use litgen online</a></li>
Expand All @@ -178,7 +178,7 @@
<li class="toctree-l1"><a class="reference internal" href="example_bindings/DaftLib/Readme.html">Generate binding files for a library</a></li>
<li class="toctree-l1"><a class="reference internal" href="01_15_00_cmake_helpers.html">CMake helpers</a></li>
</ul>
<p aria-level="2" class="caption" role="heading"><span class="caption-text">Advanced Topics</span></p>
<p aria-level="2" class="caption" role="heading"><span class="caption-text">Bindings - Advanced Topics</span></p>
<ul class="nav bd-sidenav">
<li class="toctree-l1"><a class="reference internal" href="02_00_00_options.html">litgen options</a></li>
<li class="toctree-l1"><a class="reference internal" href="02_05_00_headers.html">Headers processing</a></li>
Expand Down Expand Up @@ -439,17 +439,17 @@ <h1>Use litgen online<a class="headerlink" href="#use-litgen-online" title="Perm
<span class="c1"># This namespace will not be outputted as a python module</span>
<span class="n">options</span><span class="o">.</span><span class="n">namespace_root__regex</span> <span class="o">=</span> <span class="s2">&quot;MyNamespace&quot;</span>
<span class="c1"># All functions, modules and namespaces names are converted to snake case</span>
<span class="n">options</span><span class="o">.</span><span class="n">python_convert_to_snake_case</span> <span class="o">=</span> <span class="kc">True</span>
<span class="n">options</span><span class="o">.</span><span class="n">python_convert_to_snake_case</span> <span class="o">=</span> <span class="kc">True</span>
<span class="c1"># This is an API marker in the C++ code (for shared libraries code)</span>
<span class="n">options</span><span class="o">.</span><span class="n">srcmlcpp_options</span><span class="o">.</span><span class="n">functions_api_prefixes</span> <span class="o">=</span> <span class="s2">&quot;^MY_API$&quot;</span>
<span class="c1"># Also create bindings for functions that do not have the API marker</span>
<span class="n">options</span><span class="o">.</span><span class="n">fn_exclude_non_api</span> <span class="o">=</span> <span class="kc">False</span>
<span class="c1"># Optional comment that can be added to non API functions</span>
<span class="n">options</span><span class="o">.</span><span class="n">fn_non_api_comment</span> <span class="o">=</span> <span class="s2">&quot;&quot;</span>
<span class="n">options</span><span class="o">.</span><span class="n">fn_non_api_comment</span> <span class="o">=</span> <span class="s2">&quot;&quot;</span>
<span class="c1"># &quot;Box&quot; immutable functions parameter when they should be modifiable</span>
<span class="n">options</span><span class="o">.</span><span class="n">fn_params_replace_modifiable_immutable_by_boxed__regex</span> <span class="o">=</span> <span class="sa">r</span><span class="s2">&quot;.*&quot;</span>
<span class="n">options</span><span class="o">.</span><span class="n">fn_params_replace_modifiable_immutable_by_boxed__regex</span> <span class="o">=</span> <span class="sa">r</span><span class="s2">&quot;.*&quot;</span>
<span class="c1"># Which numeric and string preprocessor do we want to export</span>
<span class="n">options</span><span class="o">.</span><span class="n">macro_define_include_by_name__regex</span> <span class="o">=</span> <span class="s2">&quot;^MY_&quot;</span>
<span class="n">options</span><span class="o">.</span><span class="n">macro_define_include_by_name__regex</span> <span class="o">=</span> <span class="s2">&quot;^MY_&quot;</span>

<span class="n">code</span> <span class="o">=</span> <span class="s2">&quot;&quot;&quot;</span>
<span class="s2">// This namespace is not outputed as a submodule, since it is marked as Root (see options.namespace_root__regex)</span>
Expand Down Expand Up @@ -547,7 +547,7 @@ <h1>Use litgen online<a class="headerlink" href="#use-litgen-online" title="Perm
</style>

<script>
function copy_code_1700253274195_388() {
function copy_code_1702557035867_865() {
let code = `#################### <generated_from:BoxedTypes> ####################
class BoxedBool:
value: bool
Expand Down Expand Up @@ -617,10 +617,10 @@ <h1>Use litgen online<a class="headerlink" href="#use-litgen-online" title="Perm
navigator.clipboard.writeText(code);
}
</script>
<button class="collapsible_header" id="btn_1700253274195_388_2" >Corresponding python decls (stub)</button>
<div class="collapsible_content" id="content_1700253274195_388_2">
<button class="collapsible_header" id="btn_1702557035867_865_2" >Corresponding python decls (stub)</button>
<div class="collapsible_content" id="content_1702557035867_865_2">
<div>
<button onclick="copy_code_1700253274195_388()" align="right">copy &#x270d;</button>
<button onclick="copy_code_1702557035867_865()" align="right">copy &#x270d;</button>
</div>
<style>pre { line-height: 125%; }
td.linenos .normal { color: inherit; background-color: transparent; padding-left: 5px; padding-right: 5px; }
Expand Down Expand Up @@ -762,10 +762,10 @@ <h1>Use litgen online<a class="headerlink" href="#use-litgen-online" title="Perm
</div>

<script>
var button = document.getElementById("btn_1700253274195_388_2");
var button = document.getElementById("btn_1702557035867_865_2");
button.addEventListener("click", function() {
this.classList.toggle("collapsible_header_opened");
var content = document.getElementById("content_1700253274195_388_2");
var content = document.getElementById("content_1702557035867_865_2");
if (content.style.maxHeight){
content.style.maxHeight = null;
} else {
Expand All @@ -775,9 +775,9 @@ <h1>Use litgen online<a class="headerlink" href="#use-litgen-online" title="Perm
</script>

<script>
var collapsible_header = document.getElementById("btn_1700253274195_388_2");
var collapsible_header = document.getElementById("btn_1702557035867_865_2");
collapsible_header.classList.toggle("collapsible_header_opened");
var collapsible_content = document.getElementById("content_1700253274195_388_2");
var collapsible_content = document.getElementById("content_1702557035867_865_2");
collapsible_content.style.maxHeight = "80em";
</script>
<br/>
Expand Down Expand Up @@ -826,7 +826,7 @@ <h1>Use litgen online<a class="headerlink" href="#use-litgen-online" title="Perm
</style>

<script>
function copy_code_1700253274178_614() {
function copy_code_1702557035851_024() {
let code = `//////////////////// <generated_from:BoxedTypes> ////////////////////
auto pyClassBoxedBool =
py::class_<BoxedBool>
Expand Down Expand Up @@ -904,10 +904,10 @@ <h1>Use litgen online<a class="headerlink" href="#use-litgen-online" title="Perm
navigator.clipboard.writeText(code);
}
</script>
<button class="collapsible_header" id="btn_1700253274178_614_0" >pybind11 C++ binding code</button>
<div class="collapsible_content" id="content_1700253274178_614_0">
<button class="collapsible_header" id="btn_1702557035851_024_0" >pybind11 C++ binding code</button>
<div class="collapsible_content" id="content_1702557035851_024_0">
<div>
<button onclick="copy_code_1700253274178_614()" align="right">copy &#x270d;</button>
<button onclick="copy_code_1702557035851_024()" align="right">copy &#x270d;</button>
</div>
<style>pre { line-height: 125%; }
td.linenos .normal { color: inherit; background-color: transparent; padding-left: 5px; padding-right: 5px; }
Expand Down Expand Up @@ -1057,10 +1057,10 @@ <h1>Use litgen online<a class="headerlink" href="#use-litgen-online" title="Perm
</div>

<script>
var button = document.getElementById("btn_1700253274178_614_0");
var button = document.getElementById("btn_1702557035851_024_0");
button.addEventListener("click", function() {
this.classList.toggle("collapsible_header_opened");
var content = document.getElementById("content_1700253274178_614_0");
var content = document.getElementById("content_1702557035851_024_0");
if (content.style.maxHeight){
content.style.maxHeight = null;
} else {
Expand All @@ -1070,9 +1070,9 @@ <h1>Use litgen online<a class="headerlink" href="#use-litgen-online" title="Perm
</script>

<script>
var collapsible_header = document.getElementById("btn_1700253274178_614_0");
var collapsible_header = document.getElementById("btn_1702557035851_024_0");
collapsible_header.classList.toggle("collapsible_header_opened");
var collapsible_content = document.getElementById("content_1700253274178_614_0");
var collapsible_content = document.getElementById("content_1702557035851_024_0");
collapsible_content.style.maxHeight = "80em";
</script>
<br/>
Expand Down Expand Up @@ -1121,7 +1121,7 @@ <h1>Use litgen online<a class="headerlink" href="#use-litgen-online" title="Perm
</style>

<script>
function copy_code_1700253274179_163() {
function copy_code_1702557035851_6072() {
let code = `struct BoxedBool
{
bool value;
Expand All @@ -1132,10 +1132,10 @@ <h1>Use litgen online<a class="headerlink" href="#use-litgen-online" title="Perm
navigator.clipboard.writeText(code);
}
</script>
<button class="collapsible_header" id="btn_1700253274179_163_1" >C++ glue code</button>
<div class="collapsible_content" id="content_1700253274179_163_1">
<button class="collapsible_header" id="btn_1702557035851_6072_1" >C++ glue code</button>
<div class="collapsible_content" id="content_1702557035851_6072_1">
<div>
<button onclick="copy_code_1700253274179_163()" align="right">copy &#x270d;</button>
<button onclick="copy_code_1702557035851_6072()" align="right">copy &#x270d;</button>
</div>
<style>pre { line-height: 125%; }
td.linenos .normal { color: inherit; background-color: transparent; padding-left: 5px; padding-right: 5px; }
Expand Down Expand Up @@ -1218,10 +1218,10 @@ <h1>Use litgen online<a class="headerlink" href="#use-litgen-online" title="Perm
</div>

<script>
var button = document.getElementById("btn_1700253274179_163_1");
var button = document.getElementById("btn_1702557035851_6072_1");
button.addEventListener("click", function() {
this.classList.toggle("collapsible_header_opened");
var content = document.getElementById("content_1700253274179_163_1");
var content = document.getElementById("content_1702557035851_6072_1");
if (content.style.maxHeight){
content.style.maxHeight = null;
} else {
Expand All @@ -1231,9 +1231,9 @@ <h1>Use litgen online<a class="headerlink" href="#use-litgen-online" title="Perm
</script>

<script>
var collapsible_header = document.getElementById("btn_1700253274179_163_1");
var collapsible_header = document.getElementById("btn_1702557035851_6072_1");
collapsible_header.classList.toggle("collapsible_header_opened");
var collapsible_content = document.getElementById("content_1700253274179_163_1");
var collapsible_content = document.getElementById("content_1702557035851_6072_1");
collapsible_content.style.maxHeight = "80em";
</script>
</div></div>
Expand Down
4 changes: 2 additions & 2 deletions docs/litgen_book/01_05_10_install.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -167,7 +167,7 @@
</a>
</li>
</ul>
<p aria-level="2" class="caption" role="heading"><span class="caption-text">Basics</span></p>
<p aria-level="2" class="caption" role="heading"><span class="caption-text">Bindings - Basics</span></p>
<ul class="current nav bd-sidenav">
<li class="toctree-l1 current active has-children"><a class="reference internal" href="01_05_00_install_or_online.html">Installation or online usage</a><input checked="" class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-1"><i class="fa-solid fa-chevron-down"></i></label><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="01_05_05_online.html">Use litgen online</a></li>
Expand All @@ -178,7 +178,7 @@
<li class="toctree-l1"><a class="reference internal" href="example_bindings/DaftLib/Readme.html">Generate binding files for a library</a></li>
<li class="toctree-l1"><a class="reference internal" href="01_15_00_cmake_helpers.html">CMake helpers</a></li>
</ul>
<p aria-level="2" class="caption" role="heading"><span class="caption-text">Advanced Topics</span></p>
<p aria-level="2" class="caption" role="heading"><span class="caption-text">Bindings - Advanced Topics</span></p>
<ul class="nav bd-sidenav">
<li class="toctree-l1"><a class="reference internal" href="02_00_00_options.html">litgen options</a></li>
<li class="toctree-l1"><a class="reference internal" href="02_05_00_headers.html">Headers processing</a></li>
Expand Down
Loading

0 comments on commit 1ce8be5

Please sign in to comment.