Update docs / 2024-01-15 / 08:26:14

pthom · Jan 15, 2024 · 6afd65b · 6afd65b
1 parent b57b60a
commit 6afd65b
Show file tree

Hide file tree

Showing 13 changed files with 105 additions and 132 deletions.
diff --git a/docs/book/_sources/60_05_build.md → docs/book/_sources/build.md b/docs/book/_sources/60_05_build.md → docs/book/_sources/build.md
diff --git a/docs/book/_sources/05_05_get_started.md → docs/book/_sources/get_started.md b/docs/book/_sources/05_05_get_started.md → docs/book/_sources/get_started.md
diff --git a/docs/book/_sources/00_00_intro.md → docs/book/_sources/intro.md b/docs/book/_sources/00_00_intro.md → docs/book/_sources/intro.md
@@ -28,33 +28,6 @@ Hello ImGui is a library designed to make multiplatform app development as simpl
 * Available rendering backends: OpenGL3, Metal, Vulkan, DirectX
 
 
-## About
-
-### Support the project
-Hello ImGui is a free and open source project, and its development and maintenance require considerable efforts. 
-
-If you find it valuable for your work – especially in a commercial enterprise or a research setting – please consider supporting its development by [making a donation](https://www.paypal.com/donate/?hosted_button_id=SHJ68RVDKURZA). Thank you!
-
-<!--
-[![](https://raw.githubusercontent.com/pthom/imgui_bundle/main/bindings/imgui_bundle/doc/doc_images/btn_donate.gif)](https://www.paypal.com/donate/?hosted_button_id=SHJ68RVDKURZA)
--->
-
-### Credits
-
-Hello ImGui is based on [Dear ImGui](https://github.com/ocornut/imgui) (MIT License), by Omar Cornut. Portions use [ImGui Test Engine](https://github.com/ocornut/imgui_test_engine), which is governed by a [specific license](https://github.com/ocornut/imgui_test_engine/blob/main/imgui_test_engine/LICENSE.txt)
-
-Portions of this software use the [FreeType Project](www.freetype.org), [lunasvg](https://github.com/sammycage/lunasvg) (MIT License), [GLFW](https://www.glfw.org/) (zlib/libpng license), [SDL](https://www.libsdl.org/) (zlib license).
-
-### License
-
-Hello ImGui is licensed under the MIT License, see [LICENSE](https://github.com/pthom/hello_imgui/blob/master/LICENSE)
-
-### Contribute
-
-Quality contributions are welcome!
-
----
-
 ## Demos & real world apps
 
 ### Motto
@@ -119,14 +92,41 @@ How to use a custom 3D background in your app
 
 [Dear ImGui Bundle](https://pthom.github.io/imgui_bundle/), a full-fledged library, built on top of Hello ImGui, provides lots of additional widgets ([imgui](https://github.com/ocornut/imgui.git), [implot](https://github.com/epezent/implot), [imgui-node-editor](https://github.com/thedmd/imgui-node-editor), [ImFileDialog](https://github.com/pthom/ImFileDialog.git), [ImGuiColorTextEdit](https://github.com/BalazsJako/ImGuiColorTextEdit), [imgui_md](https://github.com/mekhontsev/imgui_md.git)), as well as complete python bindings.
 
-<img src="https://raw.githubusercontent.com/pthom/imgui_bundle/main/bindings/imgui_bundle/demos_assets/images/logo_imgui_bundle_512.png" width=200>
+<img src="https://raw.githubusercontent.com/pthom/imgui_bundle/main/bindings/imgui_bundle/demos_assets/images/logo_imgui_bundle_512.png" width=100>
 
 [online interactive demo](https://traineq.org/ImGuiBundle/emscripten/bin/demo_imgui_bundle.html) - [Source for C++ demos](https://github.com/pthom/imgui_bundle/tree/main/bindings/imgui_bundle/demos_cpp) - [Source for Python demos](https://github.com/pthom/imgui_bundle/tree/main/bindings/imgui_bundle/demos_python)
 
 
-
 ### Theme tweaking
 
 How to use the theme tweaking utilities provided by Hello ImGui
 
 [Online video tutorial](https://www.youtube.com/watch?v=4f_-3DDcAZk)
+
+---
+
+## About
+
+### Credits
+
+Hello ImGui is based on [Dear ImGui](https://github.com/ocornut/imgui) (MIT License), by Omar Cornut. Portions use [ImGui Test Engine](https://github.com/ocornut/imgui_test_engine), which is governed by a [specific license](https://github.com/ocornut/imgui_test_engine/blob/main/imgui_test_engine/LICENSE.txt)
+
+Portions of this software use the [FreeType Project](www.freetype.org), [lunasvg](https://github.com/sammycage/lunasvg) (MIT License), [GLFW](https://www.glfw.org/) (zlib/libpng license), [SDL](https://www.libsdl.org/) (zlib license).
+
+### License
+
+Hello ImGui is licensed under the MIT License, see [LICENSE](https://github.com/pthom/hello_imgui/blob/master/LICENSE)
+
+### Contribute
+
+Quality contributions are welcome!
+
+### Support the project
+
+Hello ImGui is a free and open source project, and its development and maintenance require considerable efforts.
+
+If you find it valuable for your work – especially in a commercial enterprise or a research setting – please consider supporting its development by [making a donation](https://www.paypal.com/donate/?hosted_button_id=SHJ68RVDKURZA). Thank you!
+
+<!--
+[![](https://raw.githubusercontent.com/pthom/imgui_bundle/main/bindings/imgui_bundle/doc/doc_images/btn_donate.gif)](https://www.paypal.com/donate/?hosted_button_id=SHJ68RVDKURZA)
+-->
diff --git a/docs/book/60_05_build.html → docs/book/build.html b/docs/book/60_05_build.html → docs/book/build.html
@@ -63,10 +63,9 @@
 const thebe_selector_output = ".output, .cell_output"
 </script>
     <script async="async" src="_static/sphinx-thebe.js"></script>
-    <script>DOCUMENTATION_OPTIONS.pagename = '60_05_build';</script>
+    <script>DOCUMENTATION_OPTIONS.pagename = 'build';</script>
     <link rel="index" title="Index" href="genindex.html" />
     <link rel="search" title="Search" href="search.html" />
-    <link rel="prev" title="Application parameters" href="doc_params.html" />
   <meta name="viewport" content="width=device-width, initial-scale=1"/>
   <meta name="docsearch:language" content="en"/>
   </head>
@@ -150,7 +149,7 @@
 
 
 
-<a class="navbar-brand logo" href="00_00_intro.html">
+<a class="navbar-brand logo" href="intro.html">
 
 
 
@@ -171,13 +170,13 @@
 
         <ul class="nav bd-sidenav bd-sidenav__home-link">
             <li class="toctree-l1">
-                <a class="reference internal" href="00_00_intro.html">
+                <a class="reference internal" href="intro.html">
                     Hello ImGui
                 </a>
             </li>
         </ul>
-        <ul class="current nav bd-sidenav">
-<li class="toctree-l1"><a class="reference internal" href="05_05_get_started.html">Get started</a></li>
+        <ul class="nav bd-sidenav">
+<li class="toctree-l1"><a class="reference internal" href="get_started.html">Get started</a></li>
 <li class="toctree-l1"><a class="reference internal" href="doc_api.html">API</a></li>
 
 
@@ -196,7 +195,6 @@
 
 
 
-<li class="toctree-l1 current active"><a class="current reference internal" href="#">Build instructions</a></li>
 </ul>
 
     </div>
@@ -268,7 +266,7 @@
 
 
 
-      <li><a href="https://github.com/pthom/hello_imgui/issues/new?title=Issue%20on%20page%20%2F60_05_build.html&body=Your%20issue%20content%20here." target="_blank"
+      <li><a href="https://github.com/pthom/hello_imgui/issues/new?title=Issue%20on%20page%20%2Fbuild.html&body=Your%20issue%20content%20here." target="_blank"
    class="btn btn-sm btn-source-issues-button dropdown-item"
    title="Open an issue"
    data-bs-placement="left" data-bs-toggle="tooltip"
@@ -298,7 +296,7 @@
 
 
 
-      <li><a href="_sources/60_05_build.md" target="_blank"
+      <li><a href="_sources/build.md" target="_blank"
    class="btn btn-sm btn-download-source-button dropdown-item"
    title="Download source file"
    data-bs-placement="left" data-bs-toggle="tooltip"
@@ -617,15 +615,6 @@ <h3>Android instructions<a class="headerlink" href="#android-instructions" title
                 <footer class="prev-next-footer">
 
 <div class="prev-next-area">
-    <a class="left-prev"
-       href="doc_params.html"
-       title="previous page">
-      <i class="fa-solid fa-angle-left"></i>
-      <div class="prev-next-info">
-        <p class="prev-next-subtitle">previous</p>
-        <p class="prev-next-title">Application parameters</p>
-      </div>
-    </a>
 </div>
                 </footer>
 

diff --git a/docs/book/doc_api.html b/docs/book/doc_api.html
@@ -67,7 +67,7 @@
     <link rel="index" title="Index" href="genindex.html" />
     <link rel="search" title="Search" href="search.html" />
     <link rel="next" title="Application parameters" href="doc_params.html" />
-    <link rel="prev" title="Get started" href="05_05_get_started.html" />
+    <link rel="prev" title="Get started" href="get_started.html" />
   <meta name="viewport" content="width=device-width, initial-scale=1"/>
   <meta name="docsearch:language" content="en"/>
   </head>
@@ -151,7 +151,7 @@
 
 
 
-<a class="navbar-brand logo" href="00_00_intro.html">
+<a class="navbar-brand logo" href="intro.html">
 
 
 
@@ -172,13 +172,13 @@
 
         <ul class="nav bd-sidenav bd-sidenav__home-link">
             <li class="toctree-l1">
-                <a class="reference internal" href="00_00_intro.html">
+                <a class="reference internal" href="intro.html">
                     Hello ImGui
                 </a>
             </li>
         </ul>
         <ul class="current nav bd-sidenav">
-<li class="toctree-l1"><a class="reference internal" href="05_05_get_started.html">Get started</a></li>
+<li class="toctree-l1"><a class="reference internal" href="get_started.html">Get started</a></li>
 <li class="toctree-l1 current active"><a class="current reference internal" href="#">API</a></li>
 
 
@@ -197,7 +197,6 @@
 
 
 
-<li class="toctree-l1"><a class="reference internal" href="60_05_build.html">Build instructions</a></li>
 </ul>
 
     </div>
@@ -851,7 +850,7 @@ <h2>Dpi aware Font scaling<a class="headerlink" href="#dpi-aware-font-scaling" t
 
 <div class="prev-next-area">
     <a class="left-prev"
-       href="05_05_get_started.html"
+       href="get_started.html"
        title="previous page">
       <i class="fa-solid fa-angle-left"></i>
       <div class="prev-next-info">

diff --git a/docs/book/doc_params.html b/docs/book/doc_params.html
@@ -66,7 +66,6 @@
     <script>DOCUMENTATION_OPTIONS.pagename = 'doc_params';</script>
     <link rel="index" title="Index" href="genindex.html" />
     <link rel="search" title="Search" href="search.html" />
-    <link rel="next" title="Build instructions" href="60_05_build.html" />
     <link rel="prev" title="API" href="doc_api.html" />
   <meta name="viewport" content="width=device-width, initial-scale=1"/>
   <meta name="docsearch:language" content="en"/>
@@ -151,7 +150,7 @@
 
 
 
-<a class="navbar-brand logo" href="00_00_intro.html">
+<a class="navbar-brand logo" href="intro.html">
 
 
 
@@ -172,13 +171,13 @@
 
         <ul class="nav bd-sidenav bd-sidenav__home-link">
             <li class="toctree-l1">
-                <a class="reference internal" href="00_00_intro.html">
+                <a class="reference internal" href="intro.html">
                     Hello ImGui
                 </a>
             </li>
         </ul>
         <ul class="current nav bd-sidenav">
-<li class="toctree-l1"><a class="reference internal" href="05_05_get_started.html">Get started</a></li>
+<li class="toctree-l1"><a class="reference internal" href="get_started.html">Get started</a></li>
 <li class="toctree-l1"><a class="reference internal" href="doc_api.html">API</a></li>
 
 
@@ -197,7 +196,6 @@
 
 
 
-<li class="toctree-l1"><a class="reference internal" href="60_05_build.html">Build instructions</a></li>
 </ul>
 
     </div>
@@ -1648,15 +1646,6 @@ <h2>Renderer Backend Options<a class="headerlink" href="#renderer-backend-option
         <p class="prev-next-title">API</p>
       </div>
     </a>
-    <a class="right-next"
-       href="60_05_build.html"
-       title="next page">
-      <div class="prev-next-info">
-        <p class="prev-next-subtitle">next</p>
-        <p class="prev-next-title">Build instructions</p>
-      </div>
-      <i class="fa-solid fa-angle-right"></i>
-    </a>
 </div>
                 </footer>
 

diff --git a/docs/book/genindex.html b/docs/book/genindex.html
@@ -148,7 +148,7 @@
 
 
 
-<a class="navbar-brand logo" href="00_00_intro.html">
+<a class="navbar-brand logo" href="intro.html">
 
 
 
@@ -169,13 +169,13 @@
 
         <ul class="nav bd-sidenav bd-sidenav__home-link">
             <li class="toctree-l1">
-                <a class="reference internal" href="00_00_intro.html">
+                <a class="reference internal" href="intro.html">
                     Hello ImGui
                 </a>
             </li>
         </ul>
         <ul class="nav bd-sidenav">
-<li class="toctree-l1"><a class="reference internal" href="05_05_get_started.html">Get started</a></li>
+<li class="toctree-l1"><a class="reference internal" href="get_started.html">Get started</a></li>
 <li class="toctree-l1"><a class="reference internal" href="doc_api.html">API</a></li>
 
 
@@ -194,7 +194,6 @@
 
 
 
-<li class="toctree-l1"><a class="reference internal" href="60_05_build.html">Build instructions</a></li>
 </ul>
 
     </div>

diff --git a/docs/book/05_05_get_started.html → docs/book/get_started.html b/docs/book/05_05_get_started.html → docs/book/get_started.html
@@ -63,11 +63,11 @@
 const thebe_selector_output = ".output, .cell_output"
 </script>
     <script async="async" src="_static/sphinx-thebe.js"></script>
-    <script>DOCUMENTATION_OPTIONS.pagename = '05_05_get_started';</script>
+    <script>DOCUMENTATION_OPTIONS.pagename = 'get_started';</script>
     <link rel="index" title="Index" href="genindex.html" />
     <link rel="search" title="Search" href="search.html" />
     <link rel="next" title="API" href="doc_api.html" />
-    <link rel="prev" title="Hello ImGui" href="00_00_intro.html" />
+    <link rel="prev" title="Hello ImGui" href="intro.html" />
   <meta name="viewport" content="width=device-width, initial-scale=1"/>
   <meta name="docsearch:language" content="en"/>
   </head>
@@ -151,7 +151,7 @@
 
 
 
-<a class="navbar-brand logo" href="00_00_intro.html">
+<a class="navbar-brand logo" href="intro.html">
 
 
 
@@ -172,7 +172,7 @@
 
         <ul class="nav bd-sidenav bd-sidenav__home-link">
             <li class="toctree-l1">
-                <a class="reference internal" href="00_00_intro.html">
+                <a class="reference internal" href="intro.html">
                     Hello ImGui
                 </a>
             </li>
@@ -197,7 +197,6 @@
 
 
 
-<li class="toctree-l1"><a class="reference internal" href="60_05_build.html">Build instructions</a></li>
 </ul>
 
     </div>
@@ -269,7 +268,7 @@
 
 
 
-      <li><a href="https://github.com/pthom/hello_imgui/issues/new?title=Issue%20on%20page%20%2F05_05_get_started.html&body=Your%20issue%20content%20here." target="_blank"
+      <li><a href="https://github.com/pthom/hello_imgui/issues/new?title=Issue%20on%20page%20%2Fget_started.html&body=Your%20issue%20content%20here." target="_blank"
    class="btn btn-sm btn-source-issues-button dropdown-item"
    title="Open an issue"
    data-bs-placement="left" data-bs-toggle="tooltip"
@@ -299,7 +298,7 @@
 
 
 
-      <li><a href="_sources/05_05_get_started.md" target="_blank"
+      <li><a href="_sources/get_started.md" target="_blank"
    class="btn btn-sm btn-download-source-button dropdown-item"
    title="Download source file"
    data-bs-placement="left" data-bs-toggle="tooltip"
@@ -559,7 +558,7 @@ <h2>Immediate GUI mode<a class="headerlink" href="#immediate-gui-mode" title="Pe
 
 <div class="prev-next-area">
     <a class="left-prev"
-       href="00_00_intro.html"
+       href="intro.html"
        title="previous page">
       <i class="fa-solid fa-angle-left"></i>
       <div class="prev-next-info">

diff --git a/docs/book/index.html b/docs/book/index.html
@@ -1 +1 @@
-<meta http-equiv="Refresh" content="0; url=00_00_intro.html" />
+<meta http-equiv="Refresh" content="0; url=intro.html" />
Original file line number	Diff line number	Diff line change
		@@ -1 +1 @@
		<meta http-equiv="Refresh" content="0; url=00_00_intro.html" />
		<meta http-equiv="Refresh" content="0; url=intro.html" />