Skip to content

Commit 22c4c8e

Browse files
authored
Remove dead notebook/gallery infrastructure from master (#693)
1 parent 3a7ae8f commit 22c4c8e

12 files changed

Lines changed: 3 additions & 331 deletions

.github/workflows/generate-notebooks.yml

Lines changed: 0 additions & 43 deletions
This file was deleted.

.github/workflows/test_pages.yml

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -12,11 +12,7 @@ jobs:
1212
with:
1313
python-version: '3.10'
1414
cache: 'pip'
15-
- name: Install pandoc
16-
run: sudo apt-get update && sudo apt-get install -y pandoc
17-
- name: Install dependencies and generate notebooks
18-
run: |
19-
pip install '.[docs]'
20-
python docs/generate_example_notebooks.py
2115
- name: Build and Commit
2216
uses: waltsims/pages@pyproject.toml-support
17+
with:
18+
pyproject_toml_deps: ".[docs]"

.gitignore

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,6 @@ build/
2121
src/
2222
transfer_temp/
2323
docs/_build/
24-
docs/_examples/
2524
kwave/bin/
2625

2726
# Package manager files

Makefile

Lines changed: 0 additions & 44 deletions
This file was deleted.

docs/Makefile

Lines changed: 0 additions & 28 deletions
This file was deleted.

docs/conf.py

Lines changed: 0 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,6 @@
2626
"sphinx.ext.viewcode",
2727
"sphinx_mdinclude",
2828
"sphinx.ext.extlinks", # Enables :ghfile: external links
29-
"nbsphinx",
3029
]
3130

3231
# Provide a simple GitHub branch/sha fallback for linking to example files.
@@ -66,26 +65,6 @@ def _detect_current_branch() -> str:
6665
),
6766
}
6867

69-
# -- Options for nbsphinx ----------------------------------------------------
70-
# Do not execute notebooks during the Sphinx build; they are pre-rendered.
71-
nbsphinx_execute = "never"
72-
73-
# Add an "Open in Colab" badge at the top of every notebook page.
74-
nbsphinx_prolog = r"""
75-
{% set docname = env.doc2path(env.docname, base=None) %}
76-
{% set nb_basename = docname.split('/')[-1].replace('.ipynb', '') %}
77-
78-
.. raw:: html
79-
80-
<p>
81-
<a href="https://colab.research.google.com/github/waltsims/k-wave-python/blob/master/notebooks/{{ nb_basename }}.ipynb">
82-
<img alt="Open In Colab"
83-
src="https://colab.research.google.com/assets/colab-badge.svg"
84-
style="vertical-align:text-bottom">
85-
</a>
86-
</p>
87-
"""
88-
8968
source_suffix = [".rst", ".md"]
9069
templates_path = ["_templates"]
9170
exclude_patterns = ["README.md", "_build", "Thumbs.db", ".DS_Store"]

docs/examples.rst

Lines changed: 0 additions & 70 deletions
This file was deleted.

docs/generate_example_notebooks.py

Lines changed: 0 additions & 85 deletions
This file was deleted.

docs/index.rst

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,6 @@ k-Wave is an open source acoustics toolbox for MATLAB and C++ developed by Bradl
2020
get_started/source_overview
2121
get_started/sensor_overview
2222
get_started/examples_guide
23-
examples
2423

2524
.. toctree::
2625
:caption: k-Wave-python API

jupytext.toml

Lines changed: 0 additions & 3 deletions
This file was deleted.

0 commit comments

Comments
 (0)