.\" 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-AUTOGEN" "1" "Mar 04, 2026" "9.1.0" "Sphinx"
.SH "نام (NAME)"
sphinx-autogen \- تولید صفحات ساختگی (stub) برای autodoc
.SH "خلاصه دستور (SYNOPSIS)"
.sp
\fBsphinx\-autogen\fP [\fIoptions\fP] <sourcefile> ...
.SH "توضیحات (DESCRIPTION)"
.sp
\fBsphinx\-autogen\fP ابزاری برای تولید خودکار منابع Sphinx است که با استفاده از افزونه‌ی \fBautodoc\fP \%<#\:module-sphinx\:.ext\:.autodoc>، مواردی را که در فهرست(های) \fBautosummary\fP \%<#\:directive-autosummary> قرار دارند مستندسازی می‌کند.
.sp
\fIsourcefile\fP مسیر یک یا چند سند reStructuredText است که شامل مدخل‌های \fBautosummary\fP \%<#\:directive-autosummary> همراه با گزینه‌ی تنظیم‌شده‌ی \fB:toctree:\fP هستند. \fIsourcefile\fP می‌تواند الگویی با سبک \fBfnmatch\fP \%<https://\:docs\:.python\:.org/\:3/\:library/\:fnmatch\:.html#\:module-fnmatch> باشد.
.SH "گزینه‌ها (OPTIONS)"
.INDENT 0.0
.TP
.B \-o <outputdir>
دایرکتوری برای قرار دادن فایل خروجی. اگر وجود نداشته باشد، ایجاد می‌شود. مقدار پیش‌فرض آن برابر با مقداری است که به گزینه‌ی \fB:toctree:\fP داده شده است.
.UNINDENT
.INDENT 0.0
.TP
.B \-s <suffix>, \-\-suffix <suffix>
پسوند پیش‌فرض برای استفاده در فایل‌های تولیدشده. مقدار پیش‌فرض \fBrst\fP است\&.
.UNINDENT
.INDENT 0.0
.TP
.B \-t <templates>, \-\-templates <templates>
دایرکتوری قالب‌های سفارشی. مقدار پیش‌فرض \fBNone\fP است\&.
.UNINDENT
.INDENT 0.0
.TP
.B \-i, \-\-imported\-members
مستندسازی اعضای واردشده (imported members).
.UNINDENT
.INDENT 0.0
.TP
.B \-a, \-\-respect\-module\-all
مستندسازی دقیقاً همان اعضایی که در مشخصه‌ی \fB__all__\fP ماژول تعریف شده‌اند.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-remove\-old
حذف فایل‌های موجود در دایرکتوری خروجی که دیگر تولید نمی‌شوند.
.UNINDENT
.SH "مثال‌ها (EXAMPLES)"
.sp
با فرض ساختار دایرکتوری زیر:
.INDENT 0.0
.INDENT 3.5
.sp
.EX
docs
├── index.rst
└── ...
foobar
├── foo
│   └── __init__.py
└── bar
    ├── __init__.py
    └── baz
        └── __init__.py
.EE
.UNINDENT
.UNINDENT
.sp
و با فرض اینکه \fBdocs/index.rst\fP شامل موارد زیر باشد:
.INDENT 0.0
.INDENT 3.5
.sp
.EX
Modules
=======

\&.. autosummary::
   :toctree: modules

   foobar.foo
   foobar.bar
   foobar.bar.baz
.EE
.UNINDENT
.UNINDENT
.sp
اگر دستور زیر را اجرا کنید:
.INDENT 0.0
.INDENT 3.5
.sp
.EX
$ PYTHONPATH=. sphinx\-autogen docs/index.rst
.EE
.UNINDENT
.UNINDENT
.sp
آنگاه فایل‌های ساختگی (stub) زیر در \fBdocs\fP ایجاد خواهند شد:
.INDENT 0.0
.INDENT 3.5
.sp
.EX
docs
├── index.rst
└── modules
    ├── foobar.bar.rst
    ├── foobar.bar.baz.rst
    └── foobar.foo.rst
.EE
.UNINDENT
.UNINDENT
.sp
و هر یک از این فایل‌ها شامل یک دستورالعمل \fBautodoc\fP \%<#\:module-sphinx\:.ext\:.autodoc>
و برخی اطلاعات دیگر خواهند بود.
.SH "همچنین ببینید (SEE ALSO)"
.sp
\fBsphinx\-build(1)\fP, \fBsphinx\-apidoc(1)\fP
.SH "کپی‌رایت و تکثیر (COPYRIGHT)"
2007-2026، توسعه‌دهندگان Sphinx
.\" End of generated man page.