+ Interactive online version: + +
+
+ 
+ """
+
+ if nbsphinx_export_3d_view:
+ # Export a html representation of the plotter
+ plotter.export_html(static_doc_path / f"{plotter_uid}.html")
+
+ interactive_frame = _IFrame(
+ src=f"../_static/pyvista/{plotter_uid}.html",
+ width="100%",
+ height=600,
+ )
+ tab = _widgets.Tab(
+ children=[
+ _widgets.HTML(static_frame_html),
+ _widgets.HTML(interactive_frame._repr_html_()),
+ ]
+ )
+ tab.set_title(0, "Static Scene")
+ tab.set_title(1, "Interactive Scene")
+
+ _display(tab)
+ else:
+ _display(_HTML(static_frame_html))
diff --git a/website/README.md b/website/README.md
index f4b8a956..875f784f 100644
--- a/website/README.md
+++ b/website/README.md
@@ -18,7 +18,7 @@ In the source directory of BeamMe simply execute
python website/docs/prepare_docs.py
```
-to prepare the documents for the website build (currently only the readme gets copied into the website build directory).
+to prepare the documents for the website build.
Then build the website with
diff --git a/website/docs/prepare_docs.py b/website/docs/prepare_docs.py
index 51444d77..01b72213 100644
--- a/website/docs/prepare_docs.py
+++ b/website/docs/prepare_docs.py
@@ -29,17 +29,33 @@
def prepare_docs():
"""Prepare documentation for the website.
- Currently, this only copies the README.md file to the documentation
- directory.
- """
+ This function copies all relevant files for the website.
- markdown_dir = Path("website/docs/source/md")
+ Note: We remove the target directories before copying the files to ensure
+ that no stale files remain.
+ """
# create directory which contains all the markdown files
+ markdown_dir = Path("website/docs/source/md")
+ if markdown_dir.exists():
+ shutil.rmtree(markdown_dir)
os.makedirs(markdown_dir, exist_ok=True)
# copy readme
- shutil.copy("README.md", os.path.join(markdown_dir, "README.md"))
+ shutil.copy("README.md", markdown_dir / "README.md")
+
+ # create directory which contains all the example files
+ examples_source_dir = Path("examples")
+ examples_target_dir = Path("website/docs/source/examples")
+ if examples_target_dir.exists():
+ shutil.rmtree(examples_target_dir)
+ file_extensions_to_copy = {".ipynb", ".py"}
+ for file in examples_source_dir.rglob("*"):
+ if file.is_file() and file.suffix.lower() in file_extensions_to_copy:
+ rel_path = file.relative_to(examples_source_dir)
+ dest_path = examples_target_dir / rel_path
+ dest_path.parent.mkdir(parents=True, exist_ok=True)
+ shutil.copy(file, dest_path)
if __name__ == "__main__":
diff --git a/website/docs/source/conf.py b/website/docs/source/conf.py
index 8140e4f8..ae68cc06 100644
--- a/website/docs/source/conf.py
+++ b/website/docs/source/conf.py
@@ -20,6 +20,9 @@
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
# THE SOFTWARE.
+import os
+from pathlib import Path
+
# general configuration
project = "BeamMe"
copyright = "2025, BeamMe Authors"
@@ -36,6 +39,7 @@
# extensions
extensions = [
"myst_parser", # to enable Markdown support
+ "nbsphinx", # to enable Jupyter Notebook support
"sphinxcontrib.jquery", # to enable custom JavaScript (open links in new empty tab)
]
@@ -49,3 +53,38 @@
# JavaScript configuration (to open links in new tabs)
html_js_files = ["js/custom.js"]
html_static_path = ["static"]
+
+# Always execute notebooks to ensure outputs are up-to-date
+nbsphinx_execute = "always"
+
+# Prolog for nbsphinx to add a note with a link to the GitHub source and Binder
+# at the top of each rendered html page
+nbsphinx_prolog = r"""
+{% set docname = env.doc2path(env.docname, base=False)|string %}
+{% set binder_path = "/doc/tree/" ~ docname %}
+{% set binder_urlpath = binder_path | urlencode %}
+
+.. raw:: html
+
+
+"""
+
+# Create the directory for static files created by pyvista plots
+PYVISTA_DOCS_STATIC = Path(__file__).parent.parent / "build" / "_static" / "pyvista"
+PYVISTA_DOCS_STATIC.mkdir(parents=True, exist_ok=True)
+os.environ["PYVISTA_DOCS_STATIC"] = str(PYVISTA_DOCS_STATIC)
+
+# Set a flag that we are building the docs with nbsphinx
+os.environ["IS_NBSPHINX"] = "1"
diff --git a/website/docs/source/index.rst b/website/docs/source/index.rst
index 4136b810..d80410b6 100644
--- a/website/docs/source/index.rst
+++ b/website/docs/source/index.rst
@@ -5,6 +5,7 @@
:maxdepth: 1
:hidden:
+ Examples