Skip to content

Commit

Permalink
Work on pimpl_my_class doc
Browse files Browse the repository at this point in the history
  • Loading branch information
@pthom
pthom committed Dec 14, 2023
1 parent b38484a commit 250c606
Show file tree
Hide file tree
Showing 28 changed files with 1,194 additions and 1,183 deletions.
3 changes: 2 additions & 1 deletion docs/litgen_book/00_00_intro.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -423,7 +423,8 @@ <h1>litgen<a class="headerlink" href="#litgen" title="Permalink to this heading"
<div class="note admonition">
<p class="admonition-title">What is litgen</p>
<p><code class="docutils literal notranslate"><span class="pre">litgen</span></code>, also known as <em>Literate Generator</em>, is an automatic python bindings generator for humans who like nice code and APIs.</p>
<p>It can be used to bind C++ libraries into <em>documented</em> and <em>discoverable</em> python modules using <a class="reference external" href="https://pybind11.readthedocs.io/en/stable/index.html">pybind11</a></p>
<p>It can be used to bind C++ libraries into <em>documented</em> and <em>discoverable</em> python modules using <a class="reference external" href="https://pybind11.readthedocs.io/en/stable/index.html">pybind11</a>.</p>
<p>It can also be used as C++ transformation/refactoring tool.</p>
</div>
<p>Although being relatively new (2022), litgen was battle tested on 20 different libraries totalling more than 100,000 lines of code, and it is the main driving force behind the python bindings for <a class="reference external" href="https://github.com/pthom/imgui_bundle">Dear ImGui Bundle</a>.</p>
<p>litgen puts a strong emphasis on emitting documented and discoverable code, thus providing a great experience for the final python user.</p>
Expand Down
48 changes: 24 additions & 24 deletions docs/litgen_book/01_05_05_online.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -558,7 +558,7 @@ <h1>Use litgen online<a class="headerlink" href="#use-litgen-online" title="Perm
</style>

<script>
function copy_code_1702588661842_4648() {
function copy_code_1702589511144_058() {
let code = `#################### <generated_from:BoxedTypes> ####################
class BoxedBool:
value: bool
Expand Down Expand Up @@ -628,10 +628,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_1702588661842_4648_2" >Corresponding python decls (stub)</button>
<div class="collapsible_content" id="content_1702588661842_4648_2">
<button class="collapsible_header" id="btn_1702589511144_058_2" >Corresponding python decls (stub)</button>
<div class="collapsible_content" id="content_1702589511144_058_2">
<div>
<button onclick="copy_code_1702588661842_4648()" align="right">copy &#x270d;</button>
<button onclick="copy_code_1702589511144_058()" 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 @@ -773,10 +773,10 @@ <h1>Use litgen online<a class="headerlink" href="#use-litgen-online" title="Perm
</div>

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

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

<script>
function copy_code_1702588661825_263() {
function copy_code_1702589511126_108() {
let code = `//////////////////// <generated_from:BoxedTypes> ////////////////////
auto pyClassBoxedBool =
py::class_<BoxedBool>
Expand Down Expand Up @@ -915,10 +915,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_1702588661825_263_0" >pybind11 C++ binding code</button>
<div class="collapsible_content" id="content_1702588661825_263_0">
<button class="collapsible_header" id="btn_1702589511126_108_0" >pybind11 C++ binding code</button>
<div class="collapsible_content" id="content_1702589511126_108_0">
<div>
<button onclick="copy_code_1702588661825_263()" align="right">copy &#x270d;</button>
<button onclick="copy_code_1702589511126_108()" 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 @@ -1068,10 +1068,10 @@ <h1>Use litgen online<a class="headerlink" href="#use-litgen-online" title="Perm
</div>

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

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

<script>
function copy_code_1702588661825_851() {
function copy_code_1702589511126_709() {
let code = `struct BoxedBool
{
bool value;
Expand All @@ -1143,10 +1143,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_1702588661825_851_1" >C++ glue code</button>
<div class="collapsible_content" id="content_1702588661825_851_1">
<button class="collapsible_header" id="btn_1702589511126_709_1" >C++ glue code</button>
<div class="collapsible_content" id="content_1702589511126_709_1">
<div>
<button onclick="copy_code_1702588661825_851()" align="right">copy &#x270d;</button>
<button onclick="copy_code_1702589511126_709()" 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 @@ -1229,10 +1229,10 @@ <h1>Use litgen online<a class="headerlink" href="#use-litgen-online" title="Perm
</div>

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

<script>
var collapsible_header = document.getElementById("btn_1702588661825_851_1");
var collapsible_header = document.getElementById("btn_1702589511126_709_1");
collapsible_header.classList.toggle("collapsible_header_opened");
var collapsible_content = document.getElementById("content_1702588661825_851_1");
var collapsible_content = document.getElementById("content_1702589511126_709_1");
collapsible_content.style.maxHeight = "80em";
</script>
</div></div>
Expand Down
Loading

0 comments on commit 250c606

Please sign in to comment.