Skip to content

Commit

Permalink
DOC: clarify extension document
Browse files Browse the repository at this point in the history
Co-authored-by: Chris Havlin <chris.havlin@gmail.com>
  • Loading branch information
Xarthisius and chrishavlin authored Jan 10, 2023
1 parent 90ccba9 commit bb013b7
Showing 1 changed file with 4 additions and 3 deletions.
7 changes: 4 additions & 3 deletions doc/source/developing/extensions.rst
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,10 @@ Frontend as an extension

Starting with version 4.2 of yt, any externally installed package that exports
:class:`~yt.data_objects.static_output.Dataset` subclass as an entrypoint in
``yt.frontends`` namespace in ``setup.py``:
``yt.frontends`` namespace in ``setup.py`` or ``pyproject.toml`` will be
automatically loaded and immediately available in :func:`~yt.loaders.load`.

To add an entrypoint in an external project's ``setup.py``:

.. code-block:: python
Expand All @@ -62,8 +65,6 @@ or ``pyproject.toml``:
myFrontend = "my_frontend.api:MyFrontendDataset"
myOtherFrontend = "my_frontend.api:MyOtherFrontendDataset"
will be automatically loaded and immediately available in
:func:`~yt.loaders.load`.
Extension Template
------------------
Expand Down

0 comments on commit bb013b7

Please sign in to comment.