Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
43 changes: 0 additions & 43 deletions .github/workflows/generate-notebooks.yml

This file was deleted.

8 changes: 2 additions & 6 deletions .github/workflows/test_pages.yml
Original file line number Diff line number Diff line change
Expand Up @@ -12,11 +12,7 @@ jobs:
with:
python-version: '3.10'
cache: 'pip'
- name: Install pandoc
run: sudo apt-get update && sudo apt-get install -y pandoc
- name: Install dependencies and generate notebooks
run: |
pip install '.[docs]'
python docs/generate_example_notebooks.py
- name: Build and Commit
uses: waltsims/pages@pyproject.toml-support
with:
pyproject_toml_deps: ".[docs]"
1 change: 0 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,6 @@ build/
src/
transfer_temp/
docs/_build/
docs/_examples/
kwave/bin/

# Package manager files
Expand Down
44 changes: 0 additions & 44 deletions Makefile

This file was deleted.

28 changes: 0 additions & 28 deletions docs/Makefile

This file was deleted.

21 changes: 0 additions & 21 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,6 @@
"sphinx.ext.viewcode",
"sphinx_mdinclude",
"sphinx.ext.extlinks", # Enables :ghfile: external links
"nbsphinx",
]

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

# -- Options for nbsphinx ----------------------------------------------------
# Do not execute notebooks during the Sphinx build; they are pre-rendered.
nbsphinx_execute = "never"

# Add an "Open in Colab" badge at the top of every notebook page.
nbsphinx_prolog = r"""
{% set docname = env.doc2path(env.docname, base=None) %}
{% set nb_basename = docname.split('/')[-1].replace('.ipynb', '') %}

.. raw:: html

<p>
<a href="https://colab.research.google.com/github/waltsims/k-wave-python/blob/master/notebooks/{{ nb_basename }}.ipynb">
<img alt="Open In Colab"
src="https://colab.research.google.com/assets/colab-badge.svg"
style="vertical-align:text-bottom">
</a>
</p>
"""

source_suffix = [".rst", ".md"]
templates_path = ["_templates"]
exclude_patterns = ["README.md", "_build", "Thumbs.db", ".DS_Store"]
Expand Down
70 changes: 0 additions & 70 deletions docs/examples.rst

This file was deleted.

85 changes: 0 additions & 85 deletions docs/generate_example_notebooks.py

This file was deleted.

1 change: 0 additions & 1 deletion docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,6 @@ k-Wave is an open source acoustics toolbox for MATLAB and C++ developed by Bradl
get_started/source_overview
get_started/sensor_overview
get_started/examples_guide
examples

.. toctree::
:caption: k-Wave-python API
Expand Down
3 changes: 0 additions & 3 deletions jupytext.toml

This file was deleted.

4 changes: 1 addition & 3 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -54,9 +54,7 @@ docs = [ "sphinx-mdinclude==0.6.2",
"sphinx-copybutton==0.5.2",
"sphinx-tabs==3.4.7",
"sphinx-toolbox==3.8.0",
"furo==2024.8.6",
"nbsphinx==0.9.7",
"jupytext==1.16.6"]
"furo==2024.8.6"]
dev = ["pre-commit==4.5.1"]

[tool.hatch.version]
Expand Down
26 changes: 0 additions & 26 deletions run_examples.py

This file was deleted.

Loading