Skip to content
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

Jump to bottom

Use setuptools instead of distutils in docs #15477

Merged
merged 1 commit into from
Jun 20, 2023
Merged

Use setuptools instead of distutils in docs #15477

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
11 changes: 3 additions & 8 deletions docs/source/installed_packages.rst
View file
Open in desktop
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