Skip to content

Commit

Permalink
Use setuptools instead of distutils in docs
Browse files Browse the repository at this point in the history
  • Loading branch information
hauntsaninja committed Jun 20, 2023
1 parent 719e7e7 commit 0cddb08
Showing 1 changed file with 3 additions and 8 deletions.
11 changes: 3 additions & 8 deletions docs/source/installed_packages.rst
Original file line number Diff line number Diff line change
Expand Up @@ -119,7 +119,7 @@ The ``setup.py`` file could look like this:

.. code-block:: python
from distutils.core import setup
from setuptools import setup
setup(
name="SuperPackageA",
Expand All @@ -129,11 +129,6 @@ The ``setup.py`` file could look like this:
packages=["package_a"]
)
.. note::

If you use :doc:`setuptools <setuptools:index>`, you must pass the option ``zip_safe=False`` to
``setup()``, or mypy will not be able to find the installed package.

Some packages have a mix of stub files and runtime files. These packages also
require a ``py.typed`` file. An example can be seen below:

Expand All @@ -150,7 +145,7 @@ The ``setup.py`` file might look like this:

.. code-block:: python
from distutils.core import setup
from setuptools import setup
setup(
name="SuperPackageB",
Expand Down Expand Up @@ -180,7 +175,7 @@ The ``setup.py`` might look like this:

.. code-block:: python
from distutils.core import setup
from setuptools import setup
setup(
name="SuperPackageC",
Expand Down

0 comments on commit 0cddb08

Please sign in to comment.