Skip to content
Draft
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 @@ -5,5 +5,6 @@ dist/
build/
grill.egg-info/
docs/build/
docs/source/_static/wheels/*.whl
docs/Makefile
docs/make.bat
Empty file.
8 changes: 6 additions & 2 deletions docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,7 @@
'sphinx_inline_tabs',
'sphinx.ext.autosectionlabel',
'sphinxcontrib.doxylink',
'sphinx_pyrepl_web',
]

# Offset to play well with copybutton
Expand Down Expand Up @@ -101,9 +102,9 @@
# built documents.
#
# The short X.Y version.
version = '0.18'
version = '0.19'
# The full version, including alpha/beta/rc tags.
release = '0.18.0'
release = '0.19.1'

# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
Expand Down Expand Up @@ -146,6 +147,9 @@
'custom.css',
]

pyrepl_doctest_blocks = "autodoc"
pyrepl_autodoc_packages = ":project:,grill-usd-core==26.8,grill-names>=2.6.0"

# -- Options for HTMLHelp output ------------------------------------------

# Output file base name for HTML help builder.
Expand Down
1 change: 1 addition & 0 deletions docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@
pipeline
views
end_to_end
playground
api

Indices and tables
Expand Down
22 changes: 22 additions & 0 deletions docs/source/playground.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
Playground
==========

Try ``grill.cook`` and ``grill.names`` in your browser. Packages are loaded via Pyodide; USD comes from the experimental ``grill-usd-core`` WASM build.

.. attention::

This REPL is experimental. Asset creation writes to a temporary in-browser filesystem that is lost on refresh.

.. py-repl::
:packages: :project:,grill-usd-core==26.8,grill-names>=2.6.0
:repl-title: Grill Cook Playground
:no-banner:

>>> from grill import cook, names
>>> import tempfile
>>> from pathlib import Path
>>> cook.Repository.set(Path(tempfile.mkdtemp()))
>>> stage = cook.fetch_stage(cook.UsdAsset.get_anonymous())
>>> character = cook.define_taxon(stage, "Character")
>>> character
>>> cook.create_unit(character, "Hero01", label="Hero 01")
3 changes: 2 additions & 1 deletion setup.cfg
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,8 @@ include = grill.*
# python -m pip install -e .

docs =
sphinx
sphinx>=9,<10
sphinx-pyrepl-web @ git+https://github.com/chrizzFTD/sphinx-pyrepl-web.git@cursor/project-package-lists-370c
myst-parser
sphinx-toggleprompt
sphinx-copybutton
Expand Down
Loading