Skip to content

docs: update entry point configuration from setup.cfg to pyproject.toml #196

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.

Sign up for GitHub

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

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

docs: update entry point configuration from setup.cfg to pyproject.toml #196

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
18 changes: 7 additions & 11 deletions doc/source/user/v2-api.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,14 +25,12 @@ one will be served.

In order to define your entry points, your module should leverage setuptools and be
ready to be installed in the system. Then, in order to define your entry points, you
should add the following to your ``setup.cfg`` configuration file:
should add the following to your ``pyproject.toml`` configuration file:

.. code-block:: ini
.. code-block:: toml

[entry_points]

deepaas.v2.model =
my_model = package_name.module
[project.entry-points."deepaas.v2.model"]
my_model = package_name.module

This will define an entry point in the ``deepaas.v2.model`` namespace, called
``my_model``. All the required functionality will be fetched from the
Expand All @@ -42,12 +40,10 @@ This will define an entry point in the ``deepaas.v2.model`` namespace, called
If you provide a class with the required functionality, the entry point will be
defined as follows:

.. code-block:: ini

[entry_points]
.. code-block:: toml

deepaas.v2.model =
my_model = package_name.module:Class
[project.entry-points."deepaas.v2.model"]
my_model = package_name.module:Class

Again, this will define an entry point in the ``deepaas.v2.model`` namespace,
called ``my_model``. All the required functionality will be fetched
Expand Down
Loading