.\" Man page generated from reStructuredText
.\" by the Docutils 0.22.4 manpage writer.
.
.
.nr rst2man-indent-level 0
.
.de1 rstReportMargin
\\$1 \\n[an-margin]
level \\n[rst2man-indent-level]
level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
-
\\n[rst2man-indent0]
\\n[rst2man-indent1]
\\n[rst2man-indent2]
..
.de1 INDENT
.\" .rstReportMargin pre:
. RS \\$1
. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
. nr rst2man-indent-level +1
.\" .rstReportMargin post:
..
.de UNINDENT
. RE
.\" indent \\n[an-margin]
.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
.nr rst2man-indent-level -1
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.TH "SPHINX-APIDOC" "1" "Mar 04, 2026" "9.1.0" "Sphinx"
.SH "نام (NAME)"
sphinx-apidoc \- ابزار تولید خودکار مستندات API برای اسفینکس
.SH "خلاصه دستور (SYNOPSIS)"
.sp
\fBsphinx\-apidoc\fP [\fIگزینه‌ها\fP] \-o <\fIOUTPUT_PATH\fP> <\fIMODULE_PATH\fP>
[\fIEXCLUDE_PATTERN\fP ...]
.SH "توضیحات (DESCRIPTION)"
.sp
دستور
\fBsphinx\-apidoc\fP
ابزاری برای تولید خودکار فایل‌های منبع اسفینکس (Sphinx) است که با استفاده از افزونهٔ
\fBautodoc\fP \%<#\:module-sphinx\:.ext\:.autodoc>
یک بستهٔ کامل را به شیوهٔ سایر ابزارهای مستندسازی خودکار API مستند می‌کند.
.sp
مقدار
\fIMODULE_PATH\fP
مسیر بستهٔ پایتونی است که باید مستند شود، و
\fIOUTPUT_PATH\fP
دایرکتوری محل قرارگیری فایل‌های منبع تولیدشده است. هرگونه
\fIEXCLUDE_PATTERN\fP
مشخص‌شده، الگوهای فایل و/یا دایرکتوری به سبک fnmatch
\%<https://\:docs\:.python\:.org/\:3/\:library/\:fnmatch\:.html>
هستند که از فرآیند تولید مستثنی خواهند شد.
.sp
\fBهشدار:\fP
.INDENT 0.0
.INDENT 3.5
دستور
\fBsphinx\-apidoc\fP
فایل‌های منبعی تولید می‌کند که از
\fBsphinx.ext.autodoc\fP \%<#\:module-sphinx\:.ext\:.autodoc>
برای مستندسازی تمامی ماژول‌های یافت‌شده استفاده می‌کنند. اگر ماژولی هنگام وارد کردن (import) دارای اثرات جانبی (side effects) باشد، این اثرات در زمان اجرای
\fBsphinx\-build\fP
توسط
\fBautodoc\fP
اجرا خواهند شد.
.sp
اگر در حال مستندسازی اسکریپت‌ها هستید (در مقایسه با ماژول‌های کتابخانه‌ای)، اطمینان حاصل کنید که روال اصلی آن‌ها توسط شرط
\fBif __name__ == \(aq__main__\(aq\fP
محافظت شده باشد.
.UNINDENT
.UNINDENT
.SH "گزینه‌ها (OPTIONS)"
.INDENT 0.0
.TP
.B \-o <OUTPUT_PATH>
دایرکتوری برای قرار دادن فایل‌های خروجی. اگر وجود نداشته باشد، ایجاد می‌شود.
.UNINDENT
.INDENT 0.0
.TP
.B \-q
هیچ پیامی در خروجی استاندارد چاپ نمی‌کند؛ فقط هشدارها و خطاها را در خطای استاندارد می‌نویسد.
.UNINDENT
.INDENT 0.0
.TP
.B \-f, \-\-force
بازنویسی اجباری هرگونه فایل تولیدشدهٔ موجود.
.UNINDENT
.INDENT 0.0
.TP
.B \-l, \-\-follow\-links
پیوندهای نمادین (symbolic links) را دنبال می‌کند. مقدار پیش‌فرض: \fBFalse\fP\&.
.UNINDENT
.INDENT 0.0
.TP
.B \-n, \-\-dry\-run
هیچ فایلی را ایجاد یا حذف نمی‌کند.
.UNINDENT
.INDENT 0.0
.TP
.B \-s <suffix>
پسوند فایل‌های منبع تولیدشده. مقدار پیش‌فرض: \fBrst\fP\&.
.UNINDENT
.INDENT 0.0
.TP
.B \-d <MAXDEPTH>
حداکثر عمق برای فایل فهرست مطالب (table of contents) تولیدشده. مقدار پیش‌فرض: \fB4\fP\&.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-tocfile
نام فایل برای فهرست مطالب. مقدار پیش‌فرض: \fBmodules\fP\&.
.UNINDENT
.INDENT 0.0
.TP
.B \-T, \-\-no\-toc
فایل فهرست مطالب ایجاد نمی‌کند. در صورت مشخص شدن \fB\-\-full\fP نادیده گرفته می‌شود.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-remove\-old
فایل‌های موجود در دایرکتوری خروجی را که دیگر تولید نمی‌شوند حذف می‌کند. با \fB\-\-full\fP سازگار نیست.
.UNINDENT
.INDENT 0.0
.TP
.B \-F, \-\-full
یک پروژهٔ کامل اسفینکس (\fBconf.py\fP، \fBMakefile\fP و غیره) را با استفاده از مکانیزمی مشابه \fBsphinx\-quickstart\fP تولید می‌کند.
.UNINDENT
.INDENT 0.0
.TP
.B \-e, \-\-separate
مستندات هر ماژول را در صفحهٔ جداگانهٔ خودش قرار می‌دهد.
.sp
اضافه‌شده در نسخهٔ 1.2.
.UNINDENT
.INDENT 0.0
.TP
.B \-E, \-\-no\-headings
برای ماژول‌ها/بسته‌ها عنوان (heading) ایجاد نمی‌کند. این گزینه برای مواقعی که docstringها از قبل حاوی عنوان هستند، مفید است.
.UNINDENT
.INDENT 0.0
.TP
.B \-P, \-\-private
ماژول‌های خصوصی (\(dq_private\(dq) را نیز شامل می‌کند.
.sp
اضافه‌شده در نسخهٔ 1.2.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-implicit\-namespaces
بدون این گزینه،
\fBsphinx\-apidoc\fP
مسیرهای
\fBsys.path\fP \%<https://\:docs\:.python\:.org/\:3/\:library/\:sys\:.html#\:sys\:.path>
را برای بسته‌های پایتون حاوی فایل‌های
\fB__init__.py\fP
یا ماژول‌های تک‌فایلی پایتون جستجو می‌کند.
.sp
در عوض، این گزینه از فضاهای نام ضمنی (implicit namespaces) مربوط به
\fBPEP 420\fP \%<https://\:peps\:.python\:.org/\:pep-0420>
استفاده می‌کند که ساختارهای مسیری مانند
\fBfoo/bar/module.py\fP
یا
\fBfoo/bar/baz/__init__.py\fP
را مجاز می‌سازد (توجه داشته باشید که
\fBfoo\fP
و
\fBbar\fP
فضای نام هستند، نه ماژول).
.UNINDENT
.INDENT 0.0
.TP
.B \-M, \-\-module\-first
مستندات ماژول را قبل از مستندات زیرماژول قرار می‌دهد.
.UNINDENT
.sp
این گزینه‌ها زمانی که \fB\-\-full\fP مشخص شده باشد استفاده می‌شوند:
.INDENT 0.0
.TP
.B \-a
مسیر module_path را به sys.path اضافه می‌کند.
.UNINDENT
.INDENT 0.0
.TP
.B \-H <project>
نام پروژه را برای درج در فایل‌های تولیدشده تنظیم می‌کند (ببینید: \fBproject\fP \%<#\:confval-project>).
.UNINDENT
.INDENT 0.0
.TP
.B \-A <author>
نام نویسنده(ها) را برای درج در فایل‌های تولیدشده تنظیم می‌کند (ببینید: \fBcopyright\fP \%<#\:confval-copyright>).
.UNINDENT
.INDENT 0.0
.TP
.B \-V <version>
نسخهٔ پروژه را برای درج در فایل‌های تولیدشده تنظیم می‌کند (ببینید: \fBversion\fP \%<#\:confval-version>).
.UNINDENT
.INDENT 0.0
.TP
.B \-R <release>
شماره انتشار (release) پروژه را برای درج در فایل‌های تولیدشده تنظیم می‌کند (ببینید: \fBrelease\fP \%<#\:confval-release>).
.UNINDENT
.sp
قالب‌بندی پروژه (Project templating)
.sp
اضافه‌شده در نسخهٔ 2.2: گزینه‌های قالب‌بندی پروژه برای sphinx\-apidoc
.INDENT 0.0
.TP
.B \-t, \-\-templatedir=TEMPLATEDIR
دایرکتوری الگوها برای فایل‌های قالب. شما می‌توانید قالب‌های فایل‌های پروژهٔ اسفینکس تولیدشده توسط apidoc را تغییر دهید. فایل‌های قالب Jinja2 زیر مجاز هستند:
.INDENT 7.0
.IP \(bu 2
\fBmodule.rst.jinja\fP
.IP \(bu 2
\fBpackage.rst.jinja\fP
.IP \(bu 2
\fBtoc.rst.jinja\fP
.IP \(bu 2
\fBroot_doc.rst.jinja\fP
.IP \(bu 2
\fBconf.py.jinja\fP
.IP \(bu 2
\fBMakefile.jinja\fP
.IP \(bu 2
\fBMakefile.new.jinja\fP
.IP \(bu 2
\fBmake.bat.jinja\fP
.IP \(bu 2
\fBmake.bat.new.jinja\fP
.UNINDENT
.sp
برای جزئیات بیشتر، لطفاً به فایل‌های قالب سیستمی ارائه‌شده توسط Sphinx مراجعه کنید.
(\fBsphinx/templates/apidoc\fP و \fBsphinx/templates/quickstart\fP)
.UNINDENT
.SH "محیط (ENVIRONMENT)"
.INDENT 0.0
.TP
.B SPHINX_APIDOC_OPTIONS
فهرستی جداشده با کاما از گزینه‌ها برای اضافه شدن به دستورالعمل‌های
\fBautomodule\fP
تولیدشده. مقدار پیش‌فرض:
\fBmembers,undoc\-members,show\-inheritance\fP\&.
.UNINDENT
.SH "همچنین ببینید (SEE ALSO)"
.sp
\fBsphinx\-build(1)\fP, \fBsphinx\-autogen(1)\fP
.SH "حق نشر (COPYRIGHT)"
2007-2026, the Sphinx developers
.\" End of generated man page.