Skip to content

Adding Examples to the Helion Docs/site #330

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 12 commits into from
Closed
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
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -92,3 +92,4 @@ benchmarks/tritonbench
site
generated
uv.lock
docs/examples/
2 changes: 2 additions & 0 deletions docs/Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,10 @@ html: clean
livehtml: clean
sphinx-autobuild "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) --open-browser --port 0


clean:
rm -rf $(BUILDDIR)/*
rm -rf examples/*

# Catch-all target: route all unknown targets to Sphinx-Build using the
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
Expand Down
11 changes: 11 additions & 0 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@
"sphinx.ext.intersphinx",
"myst_parser",
"sphinx_autodoc_typehints",
"sphinx_gallery.gen_gallery",
]

# MyST parser configuration
Expand All @@ -44,6 +45,16 @@
"tasklist",
]

sphinx_gallery_conf = {
"examples_dirs": [
"../examples",
], # path to your example scripts
"gallery_dirs": "examples", # path to where to save gallery generated output
"filename_pattern": r".*\.py$", # Include all Python files
"ignore_pattern": r"__init__\.py", # Exclude __init__.py files
"plot_gallery": "False", # Don't run the examples
}

# Templates path
templates_path = ["_templates"]

Expand Down
Loading
Loading