نام (NAME)

argparse-manpage - ساخت صفحه راهنما از شیء argparse.ArgumentParser در پایتون

خلاصه دستور (SYNOPSIS)

argparse-manpage [-h] (--module MODULE | --pyfile PYFILE) (--function FUNCTION | --object OBJECT) [--project-name PROJECT_NAME] [--prog PROG] [--version VERSION] [--description TEXT] [--author [AUTHOR]] [--url URL] [--format {pretty,single-commands-section}] [--output OUTFILE] [--manual-section MANUAL_SECTION] [--manual-title MANUAL_TITLE] [--include FILE] [--manfile FILE]

توضیحات (DESCRIPTION)

ساخت صفحه راهنما (man page) از روی شیء argparse.ArgumentParser در پایتون.

گزینه‌ها (OPTIONS)

--module MODULE

جستجوی OBJECT/FUNCTION در MODULE

--pyfile PYFILE

جستجوی OBJECT/FUNCTION در FILE

--function FUNCTION

فراخوانی FUNCTION از MODULE/FILE برای دریافت شیء ArgumentParser

--object OBJECT

دریافت شیء ArgumentParser تحت عنوان OBJECT از FUNCTION (برای به‌دست آوردن شیء argparse) از MODULE یا FILE

--project-name PROJECT_NAME

نام پروژه‌ای که برنامه مستندشده بخشی از آن است.

--prog PROG

جایگزین کردن %prog در نحوه کاربرد (usage) مربوط به ArgumentParser.

--version VERSION

نسخه برنامه، که در پاورقی صفحه راهنما نمایش داده خواهد شد.

--description TEXT

توضیحات برنامه، مورد استفاده در بخش NAME پس از بخش ابتدایی 'name - '؛ برای اطلاعات بیشتر man (7) man-pages را ببینید

--author [AUTHOR]

نویسنده برنامه. می‌تواند چندین بار مشخص شود.

--url URL

پیوند به وبگاه اصلی پروژه

--format {pretty,single-commands-section}

قالب صفحه راهنمای تولیدشده. مقدار پیش‌فرض 'pretty' است.

--output OUTFILE

فایل خروجی. پیش‌فرض stdout است.

--manual-section MANUAL_SECTION

بخش راهنما، به طور پیش‌فرض 1. برای اطلاعات بیشتر درباره بخش‌های موجود man (7) man-pages را ببینید.

--manual-title MANUAL_TITLE

عنوان راهنما، به طور پیش‌فرض "Generated Python Manual". برای راهنمایی‌های بیشتر man (7) man-pages را ببینید.

--include FILE

فایلی شامل محتوای اضافی برای صفحه راهنما.

--manfile FILE

فایلی شامل یک صفحه راهنمای کامل.

نویسندگان (AUTHORS)

Gabriele Giammatteo <gabriele.giammatteo@eng.it>

توزیع (DISTRIBUTION)

آخرین نسخه argparse-manpage را می‌توان از پیوند زیر بارگیری کرد: https://github.com/praiskup/argparse-manpage