Merge pull request #131 from LLNL/improv/wrapee_doc

added a note to mention the binding modifications.
LLNL · Oct 4, 2023 · cf1bea9 · cf1bea9
2 parents b676c9a + 53b616d
commit cf1bea9
Show file tree

Hide file tree

Showing 27 changed files with 14 additions and 7 deletions.
diff --git a/...x_rtd_theme2/sphinx_rtd_theme/__init__.py → docs/_themes/sphinx_rtd_theme/__init__.py b/...x_rtd_theme2/sphinx_rtd_theme/__init__.py → docs/_themes/sphinx_rtd_theme/__init__.py
diff --git a/..._theme2/sphinx_rtd_theme/breadcrumbs.html → ..._themes/sphinx_rtd_theme/breadcrumbs.html b/..._theme2/sphinx_rtd_theme/breadcrumbs.html → ..._themes/sphinx_rtd_theme/breadcrumbs.html
diff --git a/...x_rtd_theme2/sphinx_rtd_theme/footer.html → docs/_themes/sphinx_rtd_theme/footer.html b/...x_rtd_theme2/sphinx_rtd_theme/footer.html → docs/_themes/sphinx_rtd_theme/footer.html
diff --git a/...x_rtd_theme2/sphinx_rtd_theme/layout.html → docs/_themes/sphinx_rtd_theme/layout.html b/...x_rtd_theme2/sphinx_rtd_theme/layout.html → docs/_themes/sphinx_rtd_theme/layout.html
diff --git a/...x_rtd_theme2/sphinx_rtd_theme/search.html → docs/_themes/sphinx_rtd_theme/search.html b/...x_rtd_theme2/sphinx_rtd_theme/search.html → docs/_themes/sphinx_rtd_theme/search.html
diff --git a/...td_theme2/sphinx_rtd_theme/searchbox.html → docs/_themes/sphinx_rtd_theme/searchbox.html b/...td_theme2/sphinx_rtd_theme/searchbox.html → docs/_themes/sphinx_rtd_theme/searchbox.html
diff --git a/docs/_themes/sphinx_rtd_theme/static/css/badge_only.css b/docs/_themes/sphinx_rtd_theme/static/css/badge_only.css
diff --git a/docs/_themes/sphinx_rtd_theme/static/css/theme.css b/docs/_themes/sphinx_rtd_theme/static/css/theme.css
diff --git a/...d_theme/static/fonts/Inconsolata-Bold.ttf → ...d_theme/static/fonts/Inconsolata-Bold.ttf b/...d_theme/static/fonts/Inconsolata-Bold.ttf → ...d_theme/static/fonts/Inconsolata-Bold.ttf
diff --git a/...heme/static/fonts/Inconsolata-Regular.ttf → ...heme/static/fonts/Inconsolata-Regular.ttf b/...heme/static/fonts/Inconsolata-Regular.ttf → ...heme/static/fonts/Inconsolata-Regular.ttf
diff --git a/...hinx_rtd_theme/static/fonts/Lato-Bold.ttf → ...hinx_rtd_theme/static/fonts/Lato-Bold.ttf b/...hinx_rtd_theme/static/fonts/Lato-Bold.ttf → ...hinx_rtd_theme/static/fonts/Lato-Bold.ttf
diff --git a/...x_rtd_theme/static/fonts/Lato-Regular.ttf → ...x_rtd_theme/static/fonts/Lato-Regular.ttf b/...x_rtd_theme/static/fonts/Lato-Regular.ttf → ...x_rtd_theme/static/fonts/Lato-Regular.ttf
diff --git a/...td_theme/static/fonts/RobotoSlab-Bold.ttf → ...td_theme/static/fonts/RobotoSlab-Bold.ttf b/...td_theme/static/fonts/RobotoSlab-Bold.ttf → ...td_theme/static/fonts/RobotoSlab-Bold.ttf
diff --git a/...theme/static/fonts/RobotoSlab-Regular.ttf → ...theme/static/fonts/RobotoSlab-Regular.ttf b/...theme/static/fonts/RobotoSlab-Regular.ttf → ...theme/static/fonts/RobotoSlab-Regular.ttf
diff --git a/...heme/static/fonts/fontawesome-webfont.eot → ...heme/static/fonts/fontawesome-webfont.eot b/...heme/static/fonts/fontawesome-webfont.eot → ...heme/static/fonts/fontawesome-webfont.eot
diff --git a/...heme/static/fonts/fontawesome-webfont.svg → ...heme/static/fonts/fontawesome-webfont.svg b/...heme/static/fonts/fontawesome-webfont.svg → ...heme/static/fonts/fontawesome-webfont.svg
diff --git a/...heme/static/fonts/fontawesome-webfont.ttf → ...heme/static/fonts/fontawesome-webfont.ttf b/...heme/static/fonts/fontawesome-webfont.ttf → ...heme/static/fonts/fontawesome-webfont.ttf
diff --git a/...eme/static/fonts/fontawesome-webfont.woff → ...eme/static/fonts/fontawesome-webfont.woff b/...eme/static/fonts/fontawesome-webfont.woff → ...eme/static/fonts/fontawesome-webfont.woff
diff --git a/...me/static/fonts/fontawesome-webfont.woff2 → ...me/static/fonts/fontawesome-webfont.woff2 b/...me/static/fonts/fontawesome-webfont.woff2 → ...me/static/fonts/fontawesome-webfont.woff2
diff --git a/...hinx_rtd_theme/static/js/modernizr.min.js → ...hinx_rtd_theme/static/js/modernizr.min.js b/...hinx_rtd_theme/static/js/modernizr.min.js → ...hinx_rtd_theme/static/js/modernizr.min.js
diff --git a/...heme2/sphinx_rtd_theme/static/js/theme.js → ...hemes/sphinx_rtd_theme/static/js/theme.js b/...heme2/sphinx_rtd_theme/static/js/theme.js → ...hemes/sphinx_rtd_theme/static/js/theme.js
diff --git a/...nx_rtd_theme2/sphinx_rtd_theme/theme.conf → docs/_themes/sphinx_rtd_theme/theme.conf b/...nx_rtd_theme2/sphinx_rtd_theme/theme.conf → docs/_themes/sphinx_rtd_theme/theme.conf
diff --git a/...rtd_theme2/sphinx_rtd_theme/versions.html → docs/_themes/sphinx_rtd_theme/versions.html b/...rtd_theme2/sphinx_rtd_theme/versions.html → docs/_themes/sphinx_rtd_theme/versions.html
diff --git a/docs/_themes/sphinx_rtd_theme2/sphinx_rtd_theme/static/css/badge_only.css b/docs/_themes/sphinx_rtd_theme2/sphinx_rtd_theme/static/css/badge_only.css
diff --git a/docs/_themes/sphinx_rtd_theme2/sphinx_rtd_theme/static/css/theme.css b/docs/_themes/sphinx_rtd_theme2/sphinx_rtd_theme/static/css/theme.css
diff --git a/docs/api.rst b/docs/api.rst
@@ -77,6 +77,12 @@ In this case, tools can prioritize which tools go first or second at runtime to
 If an tool uses multiple bindings then they have to set priority to different bindings identified using `tool_name` defined within the same tool.
 
 
+.. attention::
+
+    The `gotcha_wrap` function modifies the `gotcha_binding_t wrap_actions[]` provided by the user.
+    GOTCHA does not create a copy of the binding functions and is the responsibility of the user to maintain this binding.
+
+
 ----------------------------
 Set priority of tool binding
 ----------------------------

diff --git a/docs/requirements.txt b/docs/requirements.txt
@@ -0,0 +1 @@
+sphinx-rtd-theme