Skip to content

Commit 27f7f1c

Browse files
sekyondaMetaoulgen
andauthored
Helion examples (#401)
Co-authored-by: Oguz Ulgen <[email protected]>
1 parent e0aeaf2 commit 27f7f1c

33 files changed

+2549
-294
lines changed

.gitignore

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -92,3 +92,5 @@ benchmarks/tritonbench
9292
site
9393
generated
9494
uv.lock
95+
docs/examples/
96+
docs/sg_execution_times.rst

docs/Makefile

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ livehtml: clean
1111

1212
clean:
1313
rm -rf $(BUILDDIR)/*
14+
rm -rf examples/*
1415

1516
# Catch-all target: route all unknown targets to Sphinx-Build using the
1617
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).

docs/conf.py

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,7 @@
2727
"sphinx.ext.intersphinx",
2828
"myst_parser",
2929
"sphinx_autodoc_typehints",
30+
"sphinx_gallery.gen_gallery",
3031
]
3132

3233
# MyST parser configuration
@@ -44,6 +45,16 @@
4445
"tasklist",
4546
]
4647

48+
sphinx_gallery_conf = {
49+
"examples_dirs": [
50+
"../examples",
51+
], # path to your example scripts
52+
"gallery_dirs": "examples", # path to where to save gallery generated output
53+
"filename_pattern": r".*\.py$", # Include all Python files
54+
"ignore_pattern": r"__init__\.py", # Exclude __init__.py files
55+
"plot_gallery": "False", # Don't run the examples
56+
}
57+
4758
# Templates path
4859
templates_path = ["_templates"]
4960

0 commit comments

Comments
 (0)