move book to docs_src

docs/book/.buildinfo → docs/.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: 5d6c89777ba1e0b6e8d8ffbc209988d7
+config: 46103e383dea3d715484588083ad3580
 tags: 645f666f9bcd5a90fca523b33c5a78b7

docs/book/60_05_build.html → docs/60_05_build.html

@@ -550,7 +550,7 @@ <h2>Hello ImGui CMake options:<a class="headerlink" href="#hello-imgui-cmake-opt
 <h2>OS specific instructions<a class="headerlink" href="#os-specific-instructions" title="Permalink to this heading">#</a></h2>
 <section id="windows-instructions">
 <h3>Windows instructions<a class="headerlink" href="#windows-instructions" title="Permalink to this heading">#</a></h3>
-<p>Under windows, Hello ImGui will automatically provide a <a class="reference download internal" download="" href="_downloads/4af1447f07138c0eb1b6df8b09b1f41d/HelloImGui_WinMain.cpp"><span class="xref download myst"><code class="docutils literal notranslate"><span class="pre">WinMain()</span></code> function</span></a> that will call main, and expects its signature to be <code class="docutils literal notranslate"><span class="pre">int</span> <span class="pre">main(int,</span> <span class="pre">char**)</span></code>. You may get a linker error if your main function signature is for example <code class="docutils literal notranslate"><span class="pre">int</span> <span class="pre">main()</span></code>.</p>
+<p>Under windows, Hello ImGui will automatically provide a <a class="reference download internal" download="" href="_downloads/f4eaa4ce5a71caa065915b4517c02d16/HelloImGui_WinMain.cpp"><span class="xref download myst"><code class="docutils literal notranslate"><span class="pre">WinMain()</span></code> function</span></a> that will call main, and expects its signature to be <code class="docutils literal notranslate"><span class="pre">int</span> <span class="pre">main(int,</span> <span class="pre">char**)</span></code>. You may get a linker error if your main function signature is for example <code class="docutils literal notranslate"><span class="pre">int</span> <span class="pre">main()</span></code>.</p>
 <p>You can disable this via cmake by passing <code class="docutils literal notranslate"><span class="pre">-DHELLOIMGUI_WIN32_AUTO_WINMAIN=OFF</span></code> as a command line cmake option. In this case, write your own <code class="docutils literal notranslate"><span class="pre">WinMain</span></code> under windows.</p>
 <p>Warning: if using SDL, you will need to <code class="docutils literal notranslate"><span class="pre">#define</span> <span class="pre">SDL_MAIN_HANDLED</span></code> before any inclusion of SDL.h (to refrain SDL from #defining  <code class="docutils literal notranslate"><span class="pre">#define</span> <span class="pre">main</span> <span class="pre">SDL_main</span></code>)</p>
 </section>

docs/book/_sources/05_05_get_started.md → docs/_sources/05_05_get_started.md

@@ -31,7 +31,7 @@ With this starter template, you do not need to clone HelloImGui, as it (optional
 
 See this extract from the CMakelists.txt file of the template:
 
-```{literalinclude} ../../_example_integration/CMakeLists.txt
+```{literalinclude} ../_example_integration/CMakeLists.txt
 :language: cmake
 :start-at: Build hello_imgui
 :end-at: hello_imgui_add_app
@@ -40,7 +40,7 @@ See this extract from the CMakelists.txt file of the template:
 
 ## CMake utility: hello_imgui_add_app
 
-```{literalinclude} ../../CMakeLists.txt
+```{literalinclude} ../CMakeLists.txt
 :language: cmake
 :start-at: hello_imgui_add_app is a helper function
 :end-before: include(hello_imgui_add_app)
@@ -49,7 +49,7 @@ See this extract from the CMakelists.txt file of the template:
 
 ## Assets and app customization
 
-```{literalinclude} ../../_example_integration/Readme.md
+```{literalinclude} ../_example_integration/Readme.md
 :language: markdown
 :start-after: Assets folder structure
 :end-before: Build instructions
@@ -61,7 +61,7 @@ Hello ImGui is based on [Dear ImGui](https://github.com/ocornut/imgui), which is
 
 With an Immediate mode GUI you can for example display a button and handle the click event in one line of code:
 
-```{literalinclude} ../../src/hello_imgui_demos/hello_globe/hello_globe.main.cpp
+```{literalinclude} ../src/hello_imgui_demos/hello_globe/hello_globe.main.cpp
 :language: cpp
 ```
 

docs/book/_sources/60_05_build.md → docs/_sources/60_05_build.md

@@ -24,7 +24,7 @@ In any case, follow the build instructions given in the [HelloImGui Starter Temp
 ## Available backends
 
 See documentation below (extract from [CMakeLists.txt](https://github.com/pthom/hello_imgui/blob/master/CMakeLists.txt)): 
-```{literalinclude} ../../CMakeLists.txt
+```{literalinclude} ../CMakeLists.txt
 :language: cmake
 :start-after: <Backends>
 :end-before: </Backends>
@@ -48,7 +48,7 @@ Those dependencies may be downloaded and built automatically by cmake, or you ca
 
 See documentation below (extract from [CMakeLists.txt](https://github.com/pthom/hello_imgui/blob/master/CMakeLists.txt)):
 
-```{literalinclude} ../../CMakeLists.txt
+```{literalinclude} ../CMakeLists.txt
 :language: cmake
 :start-after: <Dependencies>
 :end-before: </Dependencies>
@@ -75,7 +75,7 @@ option(HELLOIMGUI_WITH_TEST_ENGINE "Provide ImGui Test engine" OFF)
 
 ### Windows instructions
 
-Under windows, Hello ImGui will automatically provide a [`WinMain()` function](../../hello_imgui_cmake/HelloImGui_WinMain.cpp) that will call main, and expects its signature to be `int main(int, char**)`. You may get a linker error if your main function signature is for example `int main()`.
+Under windows, Hello ImGui will automatically provide a [`WinMain()` function](../hello_imgui_cmake/HelloImGui_WinMain.cpp) that will call main, and expects its signature to be `int main(int, char**)`. You may get a linker error if your main function signature is for example `int main()`.
 
 You can disable this via cmake by passing `-DHELLOIMGUI_WIN32_AUTO_WINMAIN=OFF` as a command line cmake option. In this case, write your own `WinMain` under windows.
 

docs/book_src/05_05_get_started.md → docs_src/05_05_get_started.md

@@ -31,7 +31,7 @@ With this starter template, you do not need to clone HelloImGui, as it (optional
 
 See this extract from the CMakelists.txt file of the template:
 
-```{literalinclude} ../../_example_integration/CMakeLists.txt
+```{literalinclude} ../_example_integration/CMakeLists.txt
 :language: cmake
 :start-at: Build hello_imgui
 :end-at: hello_imgui_add_app
@@ -40,7 +40,7 @@ See this extract from the CMakelists.txt file of the template:
 
 ## CMake utility: hello_imgui_add_app
 
-```{literalinclude} ../../CMakeLists.txt
+```{literalinclude} ../CMakeLists.txt
 :language: cmake
 :start-at: hello_imgui_add_app is a helper function
 :end-before: include(hello_imgui_add_app)
@@ -49,7 +49,7 @@ See this extract from the CMakelists.txt file of the template:
 
 ## Assets and app customization
 
-```{literalinclude} ../../_example_integration/Readme.md
+```{literalinclude} ../_example_integration/Readme.md
 :language: markdown
 :start-after: Assets folder structure
 :end-before: Build instructions
@@ -61,7 +61,7 @@ Hello ImGui is based on [Dear ImGui](https://github.com/ocornut/imgui), which is
 
 With an Immediate mode GUI you can for example display a button and handle the click event in one line of code:
 
-```{literalinclude} ../../src/hello_imgui_demos/hello_globe/hello_globe.main.cpp
+```{literalinclude} ../src/hello_imgui_demos/hello_globe/hello_globe.main.cpp
 :language: cpp
 ```
 

docs/book_src/60_05_build.md → docs_src/60_05_build.md

@@ -24,7 +24,7 @@ In any case, follow the build instructions given in the [HelloImGui Starter Temp
 ## Available backends
 
 See documentation below (extract from [CMakeLists.txt](https://github.com/pthom/hello_imgui/blob/master/CMakeLists.txt)): 
-```{literalinclude} ../../CMakeLists.txt
+```{literalinclude} ../CMakeLists.txt
 :language: cmake
 :start-after: <Backends>
 :end-before: </Backends>
@@ -48,7 +48,7 @@ Those dependencies may be downloaded and built automatically by cmake, or you ca
 
 See documentation below (extract from [CMakeLists.txt](https://github.com/pthom/hello_imgui/blob/master/CMakeLists.txt)):
 
-```{literalinclude} ../../CMakeLists.txt
+```{literalinclude} ../CMakeLists.txt
 :language: cmake
 :start-after: <Dependencies>
 :end-before: </Dependencies>
@@ -75,7 +75,7 @@ option(HELLOIMGUI_WITH_TEST_ENGINE "Provide ImGui Test engine" OFF)
 
 ### Windows instructions
 
-Under windows, Hello ImGui will automatically provide a [`WinMain()` function](../../hello_imgui_cmake/HelloImGui_WinMain.cpp) that will call main, and expects its signature to be `int main(int, char**)`. You may get a linker error if your main function signature is for example `int main()`.
+Under windows, Hello ImGui will automatically provide a [`WinMain()` function](../hello_imgui_cmake/HelloImGui_WinMain.cpp) that will call main, and expects its signature to be `int main(int, char**)`. You may get a linker error if your main function signature is for example `int main()`.
 
 You can disable this via cmake by passing `-DHELLOIMGUI_WIN32_AUTO_WINMAIN=OFF` as a command line cmake option. In this case, write your own `WinMain` under windows.
 

docs/book_src/_config.yml → docs_src/_config.yml

@@ -3,7 +3,7 @@
 
 title: Hello, Dear ImGui - Cross-platform Gui apps with Dear ImGui
 author: Pascal Thomet
-logo: ../../logo/logo_hello_imgui.png
+logo: ../logo/logo_hello_imgui.png
 copyright: "2024"
 
 # Force re-execution of notebooks on each build.

docs_src/doc_api.md

@@ -0,0 +1 @@
+../src/hello_imgui/doc_api.md

docs_src/doc_params.md

@@ -0,0 +1 @@
+../src/hello_imgui/doc_params.md

docs/book_src/generate_book.sh → docs_src/generate_book.sh

@@ -2,7 +2,7 @@
 
 SCRIPT_DIR="$( cd -- "$( dirname -- "${BASH_SOURCE[0]:-$0}"; )" &> /dev/null && pwd 2> /dev/null; )";
 
-REPO_DIR=$SCRIPT_DIR/../..
+REPO_DIR=$SCRIPT_DIR/..
 echo REPO_DIR=$REPO_DIR
 PYTHON_BIN_DIR=$REPO_DIR/venv/bin/
 if [ ! -d $PYTHON_BIN_DIR ]; then
@@ -12,6 +12,6 @@ fi
 
 cd $SCRIPT_DIR
 rm -rf _build
-rm -rf $REPO_DIR/docs/book
+rm -rf $REPO_DIR/docs
 $PYTHON_BIN_DIR/jupyter-book build .
-cp -a _build/html $REPO_DIR/docs/book
+cp -a _build/html $REPO_DIR/docs

tools/doc/process_md_docs.py

@@ -120,5 +120,5 @@ def process_md_file(input_file, output_file):
     process_md_file(hello_imgui_dir + "doc_params.src.md", hello_imgui_dir + "doc_params.md")
     process_md_file(hello_imgui_dir + "doc_api.src.md", hello_imgui_dir + "doc_api.md")
 
-    generate_book_script = repo_dir + "docs/book_src/generate_book.sh"
+    generate_book_script = repo_dir + "docs_src/generate_book.sh"
     os.system(generate_book_script)