Browse Source

Clarify docs about including packages

Thomas Kluyver 7 years ago
parent
commit
2d9b10da1e
1 changed files with 11 additions and 5 deletions
  1. 11 5
      doc/cfgfile.rst

+ 11 - 5
doc/cfgfile.rst

@@ -197,8 +197,9 @@ the line with the key:
 
 
 .. describe:: pypi_wheels (optional)
 .. 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.
    or eggs.
 
 
    .. versionadded:: 1.7
    .. versionadded:: 1.7
@@ -206,7 +207,8 @@ the line with the key:
 .. describe:: extra_wheel_sources (optional)
 .. describe:: extra_wheel_sources (optional)
 
 
    One or more directory paths in which to find wheels, in addition to fetching
    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.
    compatible wheel, and all extra sources have priority over PyPI.
 
 
    Relative paths are from the directory containing the config file.
    Relative paths are from the directory containing the config file.
@@ -218,6 +220,12 @@ the line with the key:
    A list of importable package and module names to include in the installer.
    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.
    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)
 .. describe:: files (optional)
 
 
    Extra files or directories to be installed with your application.
    Extra files or directories to be installed with your application.
@@ -248,8 +256,6 @@ the line with the key:
    large monolithic python packages without their samples and test suites to
    large monolithic python packages without their samples and test suites to
    achieve a smaller installer file.
    achieve a smaller installer file.
 
 
-   Please note:
-
    * The parameter is expected to contain a list of files *relative to the
    * 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
      build directory*. Therefore, to include files from a package, you have to
      start your pattern with ``pkgs/<packagename>/``.
      start your pattern with ``pkgs/<packagename>/``.