Update docs for package_dir

This commit is contained in:
Joe Rickerby
2020-04-09 15:51:00 +01:00
parent d5010b8242
commit 95bef46832
+18 -10
View File
@@ -48,26 +48,34 @@ def strtobool(val):
def main(): def main():
parser = argparse.ArgumentParser( parser = argparse.ArgumentParser(
description='Build wheels for all the platforms.', description='Build wheels for all the platforms.',
epilog=('Most options are supplied via environment variables. ' epilog='''
'See https://github.com/joerick/cibuildwheel#options for info.')) Most options are supplied via environment variables.
See https://github.com/joerick/cibuildwheel#options for info.
''')
parser.add_argument('--platform', parser.add_argument('--platform',
choices=['auto', 'linux', 'macos', 'windows'], choices=['auto', 'linux', 'macos', 'windows'],
default=os.environ.get('CIBW_PLATFORM', 'auto'), default=os.environ.get('CIBW_PLATFORM', 'auto'),
help=('Platform to build for. For "linux" you need docker running, on Mac ' help='''
'or Linux. For "macos", you need a Mac machine, and note that this ' Platform to build for. For "linux" you need docker running, on Mac
'script is going to automatically install MacPython on your system, ' or Linux. For "macos", you need a Mac machine, and note that this
'so don\'t run on your development machine. For "windows", you need to ' script is going to automatically install MacPython on your system,
'run in Windows, and it will build and test for all versions of ' so don't run on your development machine. For "windows", you need to
'Python. Default: auto.')) run in Windows, and it will build and test for all versions of
Python. Default: auto.
''')
parser.add_argument('--output-dir', parser.add_argument('--output-dir',
default=os.environ.get('CIBW_OUTPUT_DIR', 'wheelhouse'), default=os.environ.get('CIBW_OUTPUT_DIR', 'wheelhouse'),
help='Destination folder for the wheels.') help='Destination folder for the wheels.')
parser.add_argument('package_dir', parser.add_argument('package_dir',
default='.', default='.',
nargs='?', nargs='?',
help=('Path to the package that you want wheels for. Default: the current ' help='''
'directory.')) Path to the package that you want wheels for. Must be a subdirectory of
the working directory. When set, the working directory is still
considered the 'project' and is copied into the Docker container on
Linux. Default: the working directory.
''')
parser.add_argument('--print-build-identifiers', parser.add_argument('--print-build-identifiers',
action='store_true', action='store_true',