Skip to content

Commit

Permalink
Clarify docs about including packages
Browse files Browse the repository at this point in the history
  • Loading branch information
takluyver committed Nov 9, 2017
1 parent f7b2201 commit 2d9b10d
Showing 1 changed file with 11 additions and 5 deletions.
16 changes: 11 additions & 5 deletions doc/cfgfile.rst
Original file line number Diff line number Diff line change
Expand Up @@ -197,16 +197,18 @@ the line with the key:
.. describe:: pypi_wheels (optional)

A list of packages to download from PyPI, in the format ``name==version``.
These must be available as wheels; Pynsist will not try to download sdists
A list of packages in the format ``name==version`` to download from PyPI or
extract from the directories in ``extra_wheel_sources``.
These must be available as wheels; Pynsist will not try to use sdists
or eggs.

.. versionadded:: 1.7

.. describe:: extra_wheel_sources (optional)

One or more directory paths in which to find wheels, in addition to fetching
from PyPI. Each package will be retrieved from the first source containing a
from PyPI. Each package listed in ``pypi_wheels`` will be retrieved from the
first source containing a
compatible wheel, and all extra sources have priority over PyPI.

Relative paths are from the directory containing the config file.
Expand All @@ -218,6 +220,12 @@ the line with the key:
A list of importable package and module names to include in the installer.
Specify only top-level packages, i.e. without a ``.`` in the name.

.. note::

The ``packages`` option finds and copies installed packages from your
development environment. Specifying packages in ``pypi_wheels`` instead
is more reliable, and works with namespace packages.

.. describe:: files (optional)

Extra files or directories to be installed with your application.
Expand Down Expand Up @@ -248,8 +256,6 @@ the line with the key:
large monolithic python packages without their samples and test suites to
achieve a smaller installer file.

Please note:

* The parameter is expected to contain a list of files *relative to the
build directory*. Therefore, to include files from a package, you have to
start your pattern with ``pkgs/<packagename>/``.
Expand Down

0 comments on commit 2d9b10d

Please sign in to comment.