Skip to content

Commit

Permalink
Build doc
Browse files Browse the repository at this point in the history
  • Loading branch information
pthom committed Nov 24, 2024
1 parent 2d0ebef commit b4ba9e3
Show file tree
Hide file tree
Showing 16 changed files with 289 additions and 264 deletions.
247 changes: 128 additions & 119 deletions bindings/imgui_bundle/doc/Readme.adoc

Large diffs are not rendered by default.

5 changes: 4 additions & 1 deletion bindings/imgui_bundle/doc/scripts/build_doc.sh
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
# gem install pygments.rb
# brew install pandoc

this_dir=$(dirname -- "$0")
this_dir=$(cd "$(dirname "$0")"; pwd)
doc_dir=$this_dir/..
repo_dir=$doc_dir/../../..
gh_pages_dir=$repo_dir/docs
Expand All @@ -26,6 +26,9 @@ pandoc -f docbook -t markdown_strict Readme_source_pypi.xml -o ../Readme_pypi.md


# Generate multipage html doc for github pages (env_gh_pages)
echo "gh_pages_dir: $gh_pages_dir"
#exit

echo "Generating $gh_pages_dir/index.html (for github pages)"
cp Readme_source.adoc index.adoc # first copy to index.adoc, so that the main page is index.html
asciidoctor-multipage --attribute env_gh_pages=1 -D $gh_pages_dir index.adoc
Expand Down
4 changes: 2 additions & 2 deletions docs/assets_about.html
Original file line number Diff line number Diff line change
Expand Up @@ -623,7 +623,7 @@ <h2 id="assets_about">Assets</h2>
<span class="tok-w"> </span><span class="tok-p">|</span><span class="tok-w"> </span>+--<span class="tok-w"> </span>Roboto-BoldItalic.ttf
<span class="tok-w"> </span><span class="tok-p">|</span><span class="tok-w"> </span>+--<span class="tok-w"> </span>Roboto-Regular.ttf
<span class="tok-w"> </span><span class="tok-p">|</span><span class="tok-w"> </span>+--<span class="tok-w"> </span>Roboto-RegularItalic.ttf
<span class="tok-w"> </span><span class="tok-p">|</span><span class="tok-w"> </span>+--<span class="tok-w"> </span>SourceCodePro-Regular.ttf
<span class="tok-w"> </span><span class="tok-p">|</span><span class="tok-w"> </span>+--<span class="tok-w"> </span>Inconsolata-Medium.ttf
<span class="tok-w"> </span>+--<span class="tok-w"> </span>images/
<span class="tok-w"> </span>+--<span class="tok-w"> </span>markdown_broken_image.png<span class="tok-w"> </span><span class="tok-c1"># Optional: used for markdown</span>
<span class="tok-w"> </span>+--<span class="tok-w"> </span>world.png<span class="tok-w"> </span><span class="tok-c1"># Add anything in the assets folder!</span></code></pre>
Expand Down Expand Up @@ -1274,7 +1274,7 @@ <h4 id="_app_settings">App settings</h4>
</div>
<div id="footer">
<div id="footer-text">
Last updated 2024-07-05 12:09:36 +0200
Last updated 2024-11-24 13:30:59 +0100
</div>
</div>
</body>
Expand Down
2 changes: 1 addition & 1 deletion docs/cpp_specific.html
Original file line number Diff line number Diff line change
Expand Up @@ -539,7 +539,7 @@ <h3 id="_debug_native_c_in_python_scripts">Debug native C&#43;&#43; in python sc
</div>
<div id="footer">
<div id="footer-text">
Last updated 2024-07-05 12:09:36 +0200
Last updated 2024-11-24 13:30:59 +0100
</div>
</div>
</body>
Expand Down
2 changes: 1 addition & 1 deletion docs/devel_docs.html
Original file line number Diff line number Diff line change
Expand Up @@ -674,7 +674,7 @@ <h3 id="folders">Repository folders structure</h3>
</div>
<div id="footer">
<div id="footer-text">
Last updated 2024-07-05 12:09:36 +0200
Last updated 2024-11-24 13:30:59 +0100
</div>
</div>
</body>
Expand Down
2 changes: 1 addition & 1 deletion docs/faq.html
Original file line number Diff line number Diff line change
Expand Up @@ -819,7 +819,7 @@ <h4 id="_windows_linux_adapting_windows_and_font_size_when_application_is_moved_
</div>
<div id="footer">
<div id="footer-text">
Last updated 2024-07-05 12:09:36 +0200
Last updated 2024-11-24 13:30:59 +0100
</div>
</div>
</body>
Expand Down
2 changes: 1 addition & 1 deletion docs/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -695,7 +695,7 @@ <h1>Dear ImGui Bundle</h1>
</div>
<div id="footer">
<div id="footer-text">
Last updated 2024-07-05 12:09:36 +0200
Last updated 2024-11-24 13:30:59 +0100
</div>
</div>
</body>
Expand Down
2 changes: 1 addition & 1 deletion docs/install_cpp.html
Original file line number Diff line number Diff line change
Expand Up @@ -638,7 +638,7 @@ <h3 id="_run_the_c_demo">Run the C&#43;&#43; demo</h3>
</div>
<div id="footer">
<div id="footer-text">
Last updated 2024-07-05 12:09:36 +0200
Last updated 2024-11-24 13:30:59 +0100
</div>
</div>
</body>
Expand Down
2 changes: 1 addition & 1 deletion docs/install_python.html
Original file line number Diff line number Diff line change
Expand Up @@ -646,7 +646,7 @@ <h3 id="_run_the_python_demo">Run the python demo</h3>
</div>
<div id="footer">
<div id="footer-text">
Last updated 2024-07-05 12:09:36 +0200
Last updated 2024-11-24 13:30:59 +0100
</div>
</div>
</body>
Expand Down
2 changes: 1 addition & 1 deletion docs/introduction.html
Original file line number Diff line number Diff line change
Expand Up @@ -574,7 +574,7 @@ <h2 id="introduction">What&#8217;s in the pack?</h2>
</div>
<div id="footer">
<div id="footer-text">
Last updated 2024-07-05 12:09:36 +0200
Last updated 2024-11-24 13:30:59 +0100
</div>
</div>
</body>
Expand Down
2 changes: 1 addition & 1 deletion docs/manual.html
Original file line number Diff line number Diff line change
Expand Up @@ -1459,7 +1459,7 @@ <h4 id="_api_2">API:</h4>
</div>
<div id="footer">
<div id="footer-text">
Last updated 2024-07-05 12:09:36 +0200
Last updated 2024-11-24 13:30:59 +0100
</div>
</div>
</body>
Expand Down
2 changes: 1 addition & 1 deletion docs/python_specific.html
Original file line number Diff line number Diff line change
Expand Up @@ -814,7 +814,7 @@ <h3 id="_advanced_glfw_callbacks">Advanced glfw callbacks</h3>
</div>
<div id="footer">
<div id="footer-text">
Last updated 2024-07-05 12:09:36 +0200
Last updated 2024-11-24 13:30:59 +0100
</div>
</div>
</body>
Expand Down
271 changes: 140 additions & 131 deletions docs/quickstart.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/support_project.html
Original file line number Diff line number Diff line change
Expand Up @@ -514,7 +514,7 @@ <h3 id="_license_2">License</h3>
</div>
<div id="footer">
<div id="footer-text">
Last updated 2024-07-05 12:09:36 +0200
Last updated 2024-11-24 13:30:59 +0100
</div>
</div>
</body>
Expand Down
2 changes: 1 addition & 1 deletion docs/words_author.html
Original file line number Diff line number Diff line change
Expand Up @@ -642,7 +642,7 @@ <h4 id="_history">History</h4>
</div>
<div id="footer">
<div id="footer-text">
Last updated 2024-07-05 12:09:36 +0200
Last updated 2024-11-24 13:30:59 +0100
</div>
</div>
</body>
Expand Down
4 changes: 4 additions & 0 deletions justfile
Original file line number Diff line number Diff line change
Expand Up @@ -47,3 +47,7 @@ cibuild_docker_manylinux:
# Run mypy on the bindings
mypy:
cd bindings && ./mypy_bindings.sh

# Build the doc
doc:
cd bindings/imgui_bundle/doc/scripts/ && ./build_doc.sh

0 comments on commit b4ba9e3

Please sign in to comment.