Skip to content

Commit 359cca9

Browse files
committed
Fixed docs build
1 parent 8e1b100 commit 359cca9

3 files changed

Lines changed: 12 additions & 3 deletions

File tree

docs/source/conf.py

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,10 @@
3636
# List of patterns, relative to source directory, that match files and
3737
# directories to ignore when looking for source files.
3838
# This pattern also affects html_static_path and html_extra_path.
39-
exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
39+
exclude_patterns = ["_build", "Thumbs.db", ".DS_Store", "**/.ipynb_checkpoints"]
40+
41+
# nbsphinx configuration
42+
nbsphinx_execute = "never" # Don't execute notebooks during build
4043

4144

4245
# -- Options for HTML output -------------------------------------------------

docs/source/tutorials.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,4 +6,4 @@ Here are a few tutorials to help you get started.
66
.. toctree::
77
:maxdepth: 1
88

9-
tutorials/example_tutorial
9+
tutorials/example_tutorial.ipynb

setup_project.sh

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,13 @@ if [[ -f "pyproject.toml" ]]; then
5050
rm -f "pyproject.toml.bak"
5151
fi
5252

53-
# 4. Remove the test_setup_script.yml workflow since it's no longer needed
53+
# 4. Update docs/source/api/index.rst to reference the new module name
54+
if [[ -f "docs/source/api/index.rst" ]]; then
55+
LC_ALL=C sed -i.bak "s/^ app$/ ${APPNAME_UNDERSCORE}/" "docs/source/api/index.rst"
56+
rm -f "docs/source/api/index.rst.bak"
57+
fi
58+
59+
# 5. Remove the test_setup_script.yml workflow since it's no longer needed
5460
if [[ -f ".github/workflows/test_setup_script.yml" ]]; then
5561
rm -f ".github/workflows/test_setup_script.yml"
5662
fi

0 commit comments

Comments
 (0)