summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorAnderson Bravalheri <andersonbravalheri@gmail.com>2022-06-25 20:41:23 +0100
committerAnderson Bravalheri <andersonbravalheri@gmail.com>2022-06-25 20:41:23 +0100
commit17311b1f8eb8f14afd23d84bb54e7a62c666e7fe (patch)
tree56543155bd282103e6ae893f233d51911bb31f84 /docs
parentd5b5f6bef582acd2db481758c6a4c993ba4050b8 (diff)
downloadpython-setuptools-git-17311b1f8eb8f14afd23d84bb54e7a62c666e7fe.tar.gz
Add interfaces to docs
Diffstat (limited to 'docs')
-rw-r--r--docs/userguide/extension.rst18
1 files changed, 15 insertions, 3 deletions
diff --git a/docs/userguide/extension.rst b/docs/userguide/extension.rst
index 0008b6c2..58c8ec19 100644
--- a/docs/userguide/extension.rst
+++ b/docs/userguide/extension.rst
@@ -56,8 +56,8 @@ a ``foo`` command, you might add something like this to your project:
distutils.commands =
foo = mypackage.some_module:foo
-(Assuming, of course, that the ``foo`` class in ``mypackage.some_module`` is
-a ``setuptools.Command`` subclass.)
+Assuming, of course, that the ``foo`` class in ``mypackage.some_module`` is
+a ``setuptools.Command`` subclass (documented bellow).
Once a project containing such entry points has been activated on ``sys.path``,
(e.g. by running ``pip install``) the command(s) will be available to any
@@ -72,9 +72,21 @@ Custom commands should try to replicate the same overall behavior as the
original classes, and when possible, even inherit from them.
You should also consider handling exceptions such as ``CompileError``,
-``LinkError``, ``LibError``, among others. These exceptions are available in
+``LinkError``, ``LibError``, among others. These exceptions are available in
the ``setuptools.errors`` module.
+.. autoclass:: setuptools.Command
+ :members:
+
+
+Supporting sdists and editable installs in ``build`` sub-commands
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+``build`` sub-commands (like ``build_py`` and ``build_ext``)
+are encouraged to implement the following protocol:
+
+.. autoclass:: setuptools.command.build.SubCommand
+
Adding Arguments
----------------