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.

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

Note that MANIFEST.in does not affect wheels #332

Merged
merged 2 commits into from
Jun 23, 2017
Merged
Changes from 1 commit
Commits
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
8 changes: 4 additions & 4 deletions source/tutorials/distributing-packages.rst
Original file line number Diff line number Diff line change
Expand Up @@ -90,21 +90,21 @@ MANIFEST.in
~~~~~~~~~~~

A "MANIFEST.in" is needed in certain cases where you need to package additional
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Since we're here anyway, can you put the file name in backticks (or use Sphinx's :file: role) to be consistent with the note below?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sure.

files that ``python setup.py sdist (or bdist_wheel)`` don't automatically
include. To see a list of what's included by default, see the `Specifying the
files to distribute
files that are not automatically included in a source distribution. To see a
list of what's included by default, see the `Specifying the files to distribute
<https://docs.python.org/3.4/distutils/sourcedist.html#specifying-the-files-to-distribute>`_
section from the :ref:`distutils` documentation.

For an example, see the `MANIFEST.in
<https://github.com/pypa/sampleproject/blob/master/MANIFEST.in>`_ from the `PyPA
sample project <https://github.com/pypa/sampleproject>`_


For details on writing a ``MANIFEST.in`` file, see the `The MANIFEST.in template
<https://docs.python.org/2/distutils/sourcedist.html#the-manifest-in-template>`_
section from the :ref:`distutils` documentation.

.. note:: ``MANIFEST.in`` does not affect binary distributions such as
``wheels``.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think "wheels" needs to be code formatted (bonus: it fixes the weird source formatting).

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yeah, good catch, leftover from when it was bdist_wheel.


<your package>
~~~~~~~~~~~~~~
Expand Down