Skip to content

Commit

Permalink
Polish documentation about local_wheels option
Browse files Browse the repository at this point in the history
  • Loading branch information
takluyver committed Oct 5, 2018
1 parent 4f43b10 commit 81401ed
Showing 1 changed file with 18 additions and 8 deletions.
26 changes: 18 additions & 8 deletions doc/cfgfile.rst
Original file line number Diff line number Diff line change
Expand Up @@ -225,18 +225,28 @@ the line with the key:

.. describe:: local_wheels (optional)

One or more glob paths that match one or more wheel files located on the
local filesystem. All matching wheel files will be included in the installer.
For instance ``wheels\*.whl`` will include all wheel files from the relative
folder ``wheels``.

Any included wheel corresponding to the same distribution
of a wheel specified in ``pypi_wheels`` will raise an error.
One or more paths to ``.whl`` wheel files on the local filesystem.
All matching wheel files will be included in the installer.
These paths can also use *glob* patterns to match multiple wheels,
e.g. ``wheels/*.whl`` will include all wheels from the folder ``wheels``.

Pynsist checks that each pattern matches at least one file, that only
one wheel is being used for each distribution name, and that all wheels are
compatible with the target Python version.

Relative glob paths are from the directory containing the config file.
Relative paths are from the directory containing the config file.

.. versionadded:: 2.2

.. note::

The ``local_wheels`` option is useful if you're using Pynsist as a step
in a larger build process: you can use another tool to prepare all your
application's dependencies as wheels, and then pass them to Pynsist.

For simpler build processes, ``pypi_wheels`` will search PyPI for compatible
wheels, and handle downloading and caching them.

.. describe:: packages (optional)

A list of importable package and module names to include in the installer.
Expand Down

0 comments on commit 81401ed

Please sign in to comment.