pydoctor - آنلاین در ابر

برنامه:

نام

pydoctor - تولید کننده اسناد API برای پایتون

خلاصه

pydoctor [گزینه های]

شرح

Pydoctor یک تولید کننده اسناد API است که عمدتاً با تجزیه و تحلیل استاتیک کار می کند.

اساساً برای جایگزینی epydoc برای اهداف پروژه Twisted نوشته شده است
epydoc با zope.interface مشکل دارد، اما می تواند برای کدهای غیر Zope Python استفاده شود.
خوب.

OPTIONS

-h, --کمک
این پیام راهنما را نشان داده و خارج شوید

-c CONFIGFILE، - پیکربندی=CONFIGFILE
از پیکربندی این فایل استفاده کنید (هر خط فرمانی تنظیمات را از فایل لغو می کند
فایل).

-p INPUTPICKLE، --input-pikle=INPUTPICKLE
سیستم را از این فایل ترشی بارگیری کنید (پیش‌فرض: هیچ، یک سیستم خالی ایجاد می‌شود).

-o خروجی، --خروجی-ترشی=OUTPPUCKLE
سیستم را در این فایل ترشی ذخیره کنید (پیش‌فرض: هیچ، سیستم توسط ذخیره نمی‌شود
پیش فرض)

- سیستم اضافی=SYS:URLPREFIX
به دنبال اشیاء در این سیستم بگردید. پیوندهای این اشیاء دارای URLPREFIX خواهند بود
به آنها تعلق گرفت.

---کلاس سیستم=SYSTEMCLASS
نام نقطه‌دار کلاس برای ساختن یک سیستم.

--نام پروژه=نام پروژه
نام پروژه، در html ظاهر می شود.

--project-url=پروژه
آدرس پروژه، در صورت داده شدن در html ظاهر می شود.

--project-base-dir=دفترچه راهنمای پروژه
مسیر مطلق به دایرکتوری پایه پروژه. لینک های منبع محاسبه خواهند شد
بر اساس این مقدار

--آزمایش کردن
اگر اجرا هیچ تاثیری نداشت شکایت نکنید.

--pdb مانند py.test --pdb.

--make-html
تولید خروجی html

-- سرور
HTML را روی سرور محلی ارائه دهید.

--سرور-پورت=SERVER_PORT
بندر برای -- سرور برای استفاده.

--فقط محلی
سرور را فقط به لوکال هاست متصل کنید.

----مسیر=FACING_PATH
یک VHostMonster راه اندازی کنید، با تمام سردرگمی های موجود.

-- ویرایش هنگام ارائه HTML، اجازه ویرایش را بدهید.

-- بدون بررسی
هنگام ارائه HTML و اجازه ویرایش، ابتدا همه رشته‌های اسناد را بررسی نکنید.

--افزودن-بسته=بسته بندی
یک بسته به سیستم اضافه کنید. می توان برای افزودن بیش از یک بسته تکرار کرد.

--add-module=MODULE
یک ماژول به سیستم اضافه کنید. قابل تکرار است.

--prepend-package=پکیج PREPENDED
وانمود کنید که همه بسته ها در این بسته هستند. می توان برای مستندسازی بخشی از a استفاده کرد
بسته.

---resolve-aliases
این ارجاع به کلاس‌های وارد شده از ماژولی را که در آن بودند به‌روزرسانی می‌کند
به مراجعی که در آن تعریف شده اند وارد می شود.

-- مخفف-specialcase=ABBREVMAPPING
این یک لیست جفت کلید=مقدار جدا شده با کاما است. جایی که هر کلید با a مطابقت دارد
نام و مقدار ماژول مخفف مورد نظر است. این را می توان برای حل و فصل استفاده کرد
در تضاد با مخفف است که در آن شما دو یا چند ماژول دارید که با علامت شروع می شوند
همان نامه مثال: twistedcaldav=tcd.

--docformat=DOCFORMAT
فرض بر این است که رشته‌های اسنادی با فرمت epydoc در کدام فرمت هستند.

--html-موضوع=HTMLSUBJECTS
نام کامل شی برای تولید اسناد API (پیش‌فرض: همه چیز).

--html-summary-pages
فقط صفحات خلاصه را ایجاد کنید.

--html-write-function-pages
برای هر تابع و روش، فایل های HTML جداگانه بسازید. آنها به در مرتبط نیستند
هر HTML ایجاد شده توسط pydoctor، اما آنها می توانند برای پیوندهای شخص ثالث مفید باشند.

--html-output=htmloutput
دایرکتوری برای ذخیره فایل‌های HTML در (پیش‌فرض 'apidocs')

--html-writer=HTMLWRITER
نام نقطه‌دار کلاس html writer برای استفاده (پیش‌فرض 'pydoctor.nevowhtml.NevowWriter'،
نیاز به نصب Divmod Nevow دارد).

--html-viewsource-base=HTMLSOURCEBASE
این باید مسیر مرورگر trac برای بالای svn checkout ما باشد
مستند بخشی از.

--html-use-sortable
از کتابخانه JS قابل مرتب سازی برای ایجاد جداول محتویات بسته، ماژول و کلاس استفاده کنید
قابل مرتب سازی

--html-use-splitlinks
جاوا اسکریپت (غیر مزاحم) ایجاد کنید تا متدهای کلاس را در یکی نشان دهید
جدول در هر کلاس پایه یا در یک میز بزرگ.

--html-shortten-lists
جاوا اسکریپت (غیر مزاحم) ایجاد کنید تا برخی از ورودی‌ها را در لیست‌های طولانی پنهان کنید
به عنوان مثال زیر کلاس ها.

--بررسی زنده
ماژول ها را نیز وارد و بررسی کنید. XXX در حال حاضر کار نمی کند

-v, -- پرحرف
سر و صداتر باش برای نویز بیشتر قابل تکرار است.

-q, --ساکت
ساکت تر باش

--خودکار حالت خودکار: تجزیه و تحلیل تمام ماژول ها و بسته ها در فهرست کاری فعلی
و یک سرور محلی را اجرا کنید که امکان بررسی و ویرایش رشته های اسناد را فراهم می کند.

-- پرحرف در مورد=مرحله
در طول یک مرحله خاص از تولید پر سر و صدا باشید.

از pydoctor به صورت آنلاین با استفاده از خدمات onworks.net استفاده کنید