Work on pimpl_my_class doc

pthom · Dec 14, 2023 · fe781fa · fe781fa
1 parent 4dbadfe
commit fe781fa
Show file tree

Hide file tree

Showing 37 changed files with 1,229 additions and 1,117 deletions.
diff --git a/LICENSE.txt b/LICENSE.txt
@@ -2,7 +2,7 @@ srcmlcpp and litgen License (v1.00)
 Copyright (c) 2022-2023 Pascal Thomet
 
 This document is a legal agreement ("License") between you ("Licensee") and
-Thom Consulting ("Licensor") that governs your use of srcmlcpp and its associated tools, such as litgen ("Software").
+Thom Consulting ("Licensor") that governs your use of litgen and its associated tools, such as srcmlcpp ("Software").
 
 1. LICENSE MODELS
 

diff --git a/README.md b/README.md
@@ -1,8 +1,10 @@
 ![Pip](https://github.com/pthom/litgen/workflows/ci_build_and_test/badge.svg)
 
 
-litgen, aka \"Literate Generator\", an automatic python bindings generator for humans who like nice code and APIs, based on srcML (https://srcml.org)
+litgen, also known as Literate Generator, is an automatic python bindings generator for humans who like nice code and APIs.
 
-_litgen is not ready to be used outside its nest yet! Expect refactorings at a rapid pace!_
+It can be used to bind C++ libraries into documented and discoverable python modules using pybind11.
 
-[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/pthom/litgen/HEAD?labpath=packages%2Flitgen%2Flitgen-book%2F)
+It can also be used as C++ transformation/refactoring tool.
+
+[See documentation](https://pthom.github.io/litgen/)
diff --git a/docs/litgen_book/.buildinfo b/docs/litgen_book/.buildinfo
@@ -1,4 +1,4 @@
 # Sphinx build info version 1
 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: 0f54fe0f8640c68fa5ba6bcec04199d9
+config: 92d93191a82c67a0864aa1d0f9434b69
 tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/docs/litgen_book/00_00_intro.html b/docs/litgen_book/00_00_intro.html
@@ -200,7 +200,7 @@
 <ul class="nav bd-sidenav">
 <li class="toctree-l1"><a class="reference internal" href="20_00_00_cpp_intro.html">srcmlcpp: C++ code parsing</a></li>
 <li class="toctree-l1"><a class="reference internal" href="20_05_00_cpp_simple_transformations.html">Simple C++ code transformations</a></li>
-<li class="toctree-l1"><a class="reference internal" href="20_10_00_pimpl_my_class.html">PImpl my class: autogenerate PImpl boilerplate</a></li>
+<li class="toctree-l1"><a class="reference internal" href="20_10_00_pimpl_my_class.html">Pimpl my class: autogenerate PImpl boilerplate</a></li>
 <li class="toctree-l1"><a class="reference internal" href="20_15_00_pimpl_online.html">Online PImpl generation</a></li>
 </ul>
 
@@ -532,7 +532,7 @@ <h1>Table of contents<a class="headerlink" href="#table-of-contents" title="Perm
 <ul>
 <li class="toctree-l1"><a class="reference internal" href="20_00_00_cpp_intro.html">srcmlcpp: C++ code parsing</a></li>
 <li class="toctree-l1"><a class="reference internal" href="20_05_00_cpp_simple_transformations.html">Simple C++ code transformations</a></li>
-<li class="toctree-l1"><a class="reference internal" href="20_10_00_pimpl_my_class.html">PImpl my class: autogenerate PImpl boilerplate</a></li>
+<li class="toctree-l1"><a class="reference internal" href="20_10_00_pimpl_my_class.html">Pimpl my class: autogenerate PImpl boilerplate</a></li>
 <li class="toctree-l1"><a class="reference internal" href="20_15_00_pimpl_online.html">Online PImpl generation</a></li>
 </ul>
 </div>

diff --git a/docs/litgen_book/01_05_00_install_or_online.html b/docs/litgen_book/01_05_00_install_or_online.html
@@ -201,7 +201,7 @@
 <ul class="nav bd-sidenav">
 <li class="toctree-l1"><a class="reference internal" href="20_00_00_cpp_intro.html">srcmlcpp: C++ code parsing</a></li>
 <li class="toctree-l1"><a class="reference internal" href="20_05_00_cpp_simple_transformations.html">Simple C++ code transformations</a></li>
-<li class="toctree-l1"><a class="reference internal" href="20_10_00_pimpl_my_class.html">PImpl my class: autogenerate PImpl boilerplate</a></li>
+<li class="toctree-l1"><a class="reference internal" href="20_10_00_pimpl_my_class.html">Pimpl my class: autogenerate PImpl boilerplate</a></li>
 <li class="toctree-l1"><a class="reference internal" href="20_15_00_pimpl_online.html">Online PImpl generation</a></li>
 </ul>
 

diff --git a/docs/litgen_book/01_05_05_online.html b/docs/litgen_book/01_05_05_online.html
@@ -201,7 +201,7 @@
 <ul class="nav bd-sidenav">
 <li class="toctree-l1"><a class="reference internal" href="20_00_00_cpp_intro.html">srcmlcpp: C++ code parsing</a></li>
 <li class="toctree-l1"><a class="reference internal" href="20_05_00_cpp_simple_transformations.html">Simple C++ code transformations</a></li>
-<li class="toctree-l1"><a class="reference internal" href="20_10_00_pimpl_my_class.html">PImpl my class: autogenerate PImpl boilerplate</a></li>
+<li class="toctree-l1"><a class="reference internal" href="20_10_00_pimpl_my_class.html">Pimpl my class: autogenerate PImpl boilerplate</a></li>
 <li class="toctree-l1"><a class="reference internal" href="20_15_00_pimpl_online.html">Online PImpl generation</a></li>
 </ul>
 
@@ -257,7 +257,7 @@
 
 
 
-      <li><a href="https://mybinder.org/v2/gh/pthom/litgen/main?urlpath=lab/tree/packages/litgen/litgen-book/01_05_05_online.ipynb" target="_blank"
+      <li><a href="https://mybinder.org/v2/gh/pthom/litgen/main?urlpath=lab/tree/litgen-book/01_05_05_online.ipynb" target="_blank"
    class="btn btn-sm dropdown-item"
    title="Launch onBinder"
    data-bs-placement="left" data-bs-toggle="tooltip"
@@ -558,7 +558,7 @@ <h1>Use litgen online<a class="headerlink" href="#use-litgen-online" title="Perm
 </style>
 
     <script>
-       function copy_code_1702590480842_062() {
+       function copy_code_1702592179719_2478() {
             let code = `####################    <generated_from:BoxedTypes>    ####################
 class BoxedBool:
     value: bool
@@ -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_1702590480842_062_2" >Corresponding python decls (stub)</button>
-    <div class="collapsible_content" id="content_1702590480842_062_2">
+    <button class="collapsible_header" id="btn_1702592179719_2478_2" >Corresponding python decls (stub)</button>
+    <div class="collapsible_content" id="content_1702592179719_2478_2">
         <div>
-                <button onclick="copy_code_1702590480842_062()" align="right">copy &#x270d;</button>
+                <button onclick="copy_code_1702592179719_2478()" 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; }
@@ -773,10 +773,10 @@ <h1>Use litgen online<a class="headerlink" href="#use-litgen-online" title="Perm
     </div>
 
     <script>
-    var button = document.getElementById("btn_1702590480842_062_2");
+    var button = document.getElementById("btn_1702592179719_2478_2");
     button.addEventListener("click", function() {
         this.classList.toggle("collapsible_header_opened");
-        var content = document.getElementById("content_1702590480842_062_2");
+        var content = document.getElementById("content_1702592179719_2478_2");
         if (content.style.maxHeight){
           content.style.maxHeight = null;
         } else {
@@ -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_1702590480842_062_2");
+            var collapsible_header = document.getElementById("btn_1702592179719_2478_2");
             collapsible_header.classList.toggle("collapsible_header_opened");
-            var collapsible_content = document.getElementById("content_1702590480842_062_2");
+            var collapsible_content = document.getElementById("content_1702592179719_2478_2");
             collapsible_content.style.maxHeight = "80em";
             </script>
             <br/>
@@ -837,7 +837,7 @@ <h1>Use litgen online<a class="headerlink" href="#use-litgen-online" title="Perm
 </style>
 
     <script>
-       function copy_code_1702590480825_353() {
+       function copy_code_1702592179702_445() {
             let code = `////////////////////    <generated_from:BoxedTypes>    ////////////////////
 auto pyClassBoxedBool =
     py::class_<BoxedBool>
@@ -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_1702590480825_353_0" >pybind11 C++ binding code</button>
-    <div class="collapsible_content" id="content_1702590480825_353_0">
+    <button class="collapsible_header" id="btn_1702592179702_445_0" >pybind11 C++ binding code</button>
+    <div class="collapsible_content" id="content_1702592179702_445_0">
         <div>
-                <button onclick="copy_code_1702590480825_353()" align="right">copy &#x270d;</button>
+                <button onclick="copy_code_1702592179702_445()" 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; }
@@ -1068,10 +1068,10 @@ <h1>Use litgen online<a class="headerlink" href="#use-litgen-online" title="Perm
     </div>
 
     <script>
-    var button = document.getElementById("btn_1702590480825_353_0");
+    var button = document.getElementById("btn_1702592179702_445_0");
     button.addEventListener("click", function() {
         this.classList.toggle("collapsible_header_opened");
-        var content = document.getElementById("content_1702590480825_353_0");
+        var content = document.getElementById("content_1702592179702_445_0");
         if (content.style.maxHeight){
           content.style.maxHeight = null;
         } else {
@@ -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_1702590480825_353_0");
+            var collapsible_header = document.getElementById("btn_1702592179702_445_0");
             collapsible_header.classList.toggle("collapsible_header_opened");
-            var collapsible_content = document.getElementById("content_1702590480825_353_0");
+            var collapsible_content = document.getElementById("content_1702592179702_445_0");
             collapsible_content.style.maxHeight = "80em";
             </script>
             <br/>
@@ -1132,7 +1132,7 @@ <h1>Use litgen online<a class="headerlink" href="#use-litgen-online" title="Perm
 </style>
 
     <script>
-       function copy_code_1702590480825_9158() {
+       function copy_code_1702592179703_042() {
             let code = `struct BoxedBool
 {
     bool value;
@@ -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_1702590480825_9158_1" >C++ glue code</button>
-    <div class="collapsible_content" id="content_1702590480825_9158_1">
+    <button class="collapsible_header" id="btn_1702592179703_042_1" >C++ glue code</button>
+    <div class="collapsible_content" id="content_1702592179703_042_1">
         <div>
-                <button onclick="copy_code_1702590480825_9158()" align="right">copy &#x270d;</button>
+                <button onclick="copy_code_1702592179703_042()" 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; }
@@ -1229,10 +1229,10 @@ <h1>Use litgen online<a class="headerlink" href="#use-litgen-online" title="Perm
     </div>
 
     <script>
-    var button = document.getElementById("btn_1702590480825_9158_1");
+    var button = document.getElementById("btn_1702592179703_042_1");
     button.addEventListener("click", function() {
         this.classList.toggle("collapsible_header_opened");
-        var content = document.getElementById("content_1702590480825_9158_1");
+        var content = document.getElementById("content_1702592179703_042_1");
         if (content.style.maxHeight){
           content.style.maxHeight = null;
         } else {
@@ -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_1702590480825_9158_1");
+            var collapsible_header = document.getElementById("btn_1702592179703_042_1");
             collapsible_header.classList.toggle("collapsible_header_opened");
-            var collapsible_content = document.getElementById("content_1702590480825_9158_1");
+            var collapsible_content = document.getElementById("content_1702592179703_042_1");
             collapsible_content.style.maxHeight = "80em";
             </script>
             </div></div>

diff --git a/docs/litgen_book/01_05_10_install.html b/docs/litgen_book/01_05_10_install.html
@@ -201,7 +201,7 @@
 <ul class="nav bd-sidenav">
 <li class="toctree-l1"><a class="reference internal" href="20_00_00_cpp_intro.html">srcmlcpp: C++ code parsing</a></li>
 <li class="toctree-l1"><a class="reference internal" href="20_05_00_cpp_simple_transformations.html">Simple C++ code transformations</a></li>
-<li class="toctree-l1"><a class="reference internal" href="20_10_00_pimpl_my_class.html">PImpl my class: autogenerate PImpl boilerplate</a></li>
+<li class="toctree-l1"><a class="reference internal" href="20_10_00_pimpl_my_class.html">Pimpl my class: autogenerate PImpl boilerplate</a></li>
 <li class="toctree-l1"><a class="reference internal" href="20_15_00_pimpl_online.html">Online PImpl generation</a></li>
 </ul>