build: include man page in wheels #3459
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Resolves #1753
This adds the man page, if it exists, to wheels via the
data_files
keyword:https://setuptools.readthedocs.io/en/latest/references/keywords.html
The
data_files
keyword is marked as deprecated, but there doesn't seem to be another way of mapping files from one path to another in the distribution file. What it says about not being supported by wheels is wrong.package_data
doesn't seem to work here without changing build scripts. At least I wasn't able to make it work.sdist
does not include anydata_files
.Regarding the manpages themselves, it might be necessary on some systems to extend the
MANPATH
env var withMANPATH="${XDG_DATA_HOME:-$HOME/.local/share}/man:$MANPATH"
so that it looks up man pages in$XDG_DATA_HOME/man
(which defaults to$HOME/.local/share/man
) too.To validate the changes: