|
| 1 | +import faulthandler |
1 | 2 | import os |
2 | 3 | import sys |
3 | 4 |
|
4 | 5 | from sphinx_gallery.sorting import FileNameSortKey |
5 | 6 |
|
| 7 | +faulthandler.enable() # seg fault detection - as recipes prone to seg faulting |
| 8 | + |
6 | 9 | # Make main 'docs' conf.py importable |
7 | 10 | sys.path.insert(0, os.path.abspath("../../docs/source")) |
8 | 11 |
|
|
19 | 22 |
|
20 | 23 | # sphinx-gallery configuration |
21 | 24 | sphinx_gallery_conf = { |
22 | | - "examples_dirs": "recipes", # path to recipe files |
| 25 | + "examples_dirs": "recipes-source", # path to recipe files |
23 | 26 | "gallery_dirs": "recipes", # path to save gallery generated output |
| 27 | + "ignore_pattern": "/exclusions/", |
24 | 28 | "run_stale_examples": False, |
25 | 29 | # Below setting can be buggy: see: |
26 | 30 | # https://github.com/sphinx-gallery/sphinx-gallery/issues/967 |
|
29 | 33 | "doc_module": ("cf",), |
30 | 34 | "inspect_global_variables": True, |
31 | 35 | "within_subsection_order": FileNameSortKey, |
32 | | - "default_thumb_file": "_static/cf-recipe-placeholder-squarecrop.png", |
| 36 | + "default_thumb_file": "../../docs/source/_static/cf-recipe-placeholder-squarecrop.png", |
33 | 37 | "image_scrapers": ( |
34 | 38 | "matplotlib", |
35 | 39 | ), # Ensures Matplotlib images are captured |
36 | 40 | "plot_gallery": True, # Enables plot rendering |
37 | 41 | "reset_modules": ("matplotlib",), # Helps with memory management |
38 | 42 | "capture_repr": (), |
| 43 | + # "filename_pattern": r"plot", |
39 | 44 | } |
40 | 45 |
|
| 46 | +exclude_patterns = [ |
| 47 | + "exclusions/**", |
| 48 | +] |
| 49 | + |
41 | 50 | html_static_path = ["../../docs/source/_static"] |
42 | 51 | html_logo = "../../docs/source/images/logo.svg" |
43 | 52 | html_favicon = "../../docs/source/_static/favicon.ico" |
| 53 | + |
| 54 | +templates_path = ["../../docs/_templates"] |
0 commit comments