این دستور sphinx-apidoc است که می تواند در ارائه دهنده میزبانی رایگان OnWorks با استفاده از یکی از چندین ایستگاه کاری آنلاین رایگان ما مانند Ubuntu Online، Fedora Online، شبیه ساز آنلاین ویندوز یا شبیه ساز آنلاین MAC OS اجرا شود.
برنامه:
نام
sphinx-apidoc - ابزار مولد سند API Sphinx
خلاصه
ابوالهول-آپیدوک [گزینه های] -ooutputdir>sourcedir> [نام های مسیر ...]
شرح
ابوالهول-آپیدوک ابزاری برای تولید خودکار منابع Sphinx است که با استفاده از autodoc
پسوند، یک بسته کامل را به سبک سایر اسناد API خودکار مستند کنید
ابزار.
sourcedir باید به یک بسته پایتون اشاره کند. هر نام های مسیر ارائه شده مسیرهایی هستند که باید حذف شوند
از نسل
هشدار:
ابوالهول-آپیدوک فایل های منبعی را تولید می کند که استفاده می کند sphinx.ext.autodoc برای سند همه یافت شده
ماژول ها اگر هر یک از ماژول ها عوارض جانبی در واردات داشته باشد، اینها توسط اجرا می شوند اتودوک
چه زمانی ساخت ابوالهول اجرا می شود
اگر اسکریپت ها را مستند می کنید (برخلاف ماژول های کتابخانه)، از روال اصلی آنها مطمئن شوید
توسط یک محافظت می شود if __نام__ == '__اصلی__' وضعیت.
OPTIONS
-o
دایرکتوری برای قرار دادن فایل های خروجی. اگر وجود نداشته باشد، ایجاد می شود.
-f, --زور
معمولا apidoc فایل ها را بازنویسی نمی کند، مگر اینکه این گزینه داده شده باشد.
-l, --پیوندها
پیوندهای نمادین را دنبال کنید.
-n, -- خشک اجرا شود
اگر داده شود، apidoc هیچ فایلی ایجاد نمی کند.
-s
پسوند فایل های منبع تولید شده، پیش فرض است اولین.
-d
حداکثر عمق برای فایل فهرست مطالب تولید شده.
-T, --بدون توک
فایل فهرست مطالب ایجاد نکنید.
-F, --پر شده
اگر داده شود، یک پروژه کامل Sphinx ایجاد می شود (conf.py, makefile و غیره) با استفاده از
اسفینکس-شروع سریع.
-e, --جداگانه، مجزا
هر فایل ماژول را در صفحه خودش قرار دهید.
-E, -- بدون سرفصل
برای ماژول ها/بسته ها عنوان ایجاد نکنید
-P, --خصوصی
شامل ماژول های "_private".
از این گزینه ها استفاده می شود -F:
-H
نام پروژه برای قرار دادن در پیکربندی.
-A
نام (های) نویسنده برای قرار دادن در پیکربندی.
-V
نسخه پروژه
-R
انتشار پروژه
با استفاده از خدمات onworks.net به صورت آنلاین از Sphinx-apidoc استفاده کنید
