Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
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
2 changes: 1 addition & 1 deletion docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -195,7 +195,7 @@
# Allow linking objects on other Sphinx sites seamlessly:
intersphinx_mapping.update(
# python=('https://docs.python.org/3', None),
python=('https://docs.python.org/3.11', None),
python=('https://docs.python.org/3', None),
# ^-- Python 3.11 is required because it still contains `distutils`.
# Just leaving it as `3` would imply 3.12+, but that causes an
# error with the cross references to distutils functions.
Expand Down
4 changes: 2 additions & 2 deletions docs/deprecated/distutils/apiref.rst
Original file line number Diff line number Diff line change
Expand Up @@ -1259,8 +1259,8 @@ other utility module.
doing, leave it set to ``None``.

.. versionchanged:: 3.2.3
Create ``.pyc`` files with an :func:`import magic tag
<imp.get_tag>` in their name, in a :file:`__pycache__` subdirectory
Create ``.pyc`` files with an import magic tag
(``imp.get_tag``) in their name, in a :file:`__pycache__` subdirectory
instead of files without tag in the current directory.

.. versionchanged:: 3.5
Expand Down
7 changes: 7 additions & 0 deletions docs/userguide/declarative_config.rst
Original file line number Diff line number Diff line change
Expand Up @@ -214,6 +214,13 @@ Metadata
The aliases given below are supported for compatibility reasons,
but their use is not advised.

.. note::
The ``license_file`` alias (singular) for ``license_files`` was deprecated
in ``setuptools`` 42.0.0. If you see a warning like
``The license_file parameter is deprecated, use license_files instead``,
change the key in your ``setup.cfg`` from ``license_file`` to
``license_files``.

============================== ================= ================= =============== ==========
Key Aliases Type Minimum Version Notes
============================== ================= ================= =============== ==========
Expand Down
12 changes: 12 additions & 0 deletions docs/userguide/miscellaneous.rst
Original file line number Diff line number Diff line change
Expand Up @@ -113,6 +113,18 @@ brackets (which may contain character ranges, e.g., ``[a-z]`` or
``[a-fA-F0-9]``). Setuptools also has support for ``**`` matching
zero or more characters including forward slash, backslash, and colon.

.. note::
``recursive-include`` requires **at least one file pattern**; the directory
pattern alone is not enough. For example, to include all ``.html`` files
under ``templates/``, write:

.. code-block:: bash

recursive-include templates *.html

Writing ``recursive-include templates`` (without a pattern) is invalid and
will include nothing.

Directory patterns are relative to the root of the project directory; e.g.,
``graft example*`` will include a directory named :file:`examples` in the
project root but will not include :file:`docs/examples/`.
Expand Down