.\" 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-QUICKSTART" "1" "Mar 04, 2026" "9.1.0" "Sphinx"
.SH "نام (NAME)"
sphinx\-quickstart \- ابزار تولید قالب مستندات Sphinx
.SH "خلاصه دستور (SYNOPSIS)"
.sp
\fBsphinx\-quickstart\fP
.SH "توضیحات (DESCRIPTION)"
.sp
دستور \fBsphinx\-quickstart\fP ابزاری تعاملی است که سوالاتی درباره پروژه شما می‌پرسد و سپس یک دایرکتوری کامل از مستندات و یک Makefile نمونه برای استفاده با \fBsphinx\-build(1)\fP\& تولید می‌کند.
.SH "گزینه‌ها (OPTIONS)"
.INDENT 0.0
.TP
.B \-q, \-\-quiet
حالت بی‌صدا که از ویزارد تعاملی برای تعیین گزینه‌ها صرف‌نظر می‌کند. این گزینه به گزینه‌های \fI\-p\fP، \fI\-a\fP و \fI\-v\fP نیاز دارد.
.UNINDENT
.INDENT 0.0
.TP
.B \-h, \-\-help, \-\-version
نمایش خلاصه نحوه استفاده یا نسخه Sphinx.
.UNINDENT
.sp
گزینه‌های ساختار
.INDENT 0.0
.TP
.B \-\-sep
در صورت تعیین، دایرکتوری‌های سورس (source) و ساخت (build) را از یکدیگر جدا می‌کند.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-no\-sep
در صورت تعیین، دایرکتوری ساخت را درون دایرکتوری سورس ایجاد می‌کند.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-dot=DOT
درون دایرکتوری ریشه، دو دایرکتوری دیگر ایجاد خواهد شد؛ \(dq_templates\(dq برای قالب‌های سفارشی HTML و \(dq_static\(dq برای شیوه‌نامه‌های سفارشی و سایر فایل‌های ایستا. می‌توانید پیشوند دیگری (مانند \(dq.\(dq) را برای جایگزینی با خط زیر (underscore) وارد کنید.
.UNINDENT
.sp
گزینه‌های پایه‌ای پروژه
.INDENT 0.0
.TP
.B \-p PROJECT, \-\-project=PROJECT
نام پروژه تنظیم خواهد شد. (نگاه کنید به \fBproject\fP \%<#\:confval-project>).
.UNINDENT
.INDENT 0.0
.TP
.B \-a AUTHOR, \-\-author=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=RELEASE
شماره انتشار (Release) پروژه. (نگاه کنید به \fBrelease\fP \%<#\:confval-release>).
.UNINDENT
.INDENT 0.0
.TP
.B \-l LANGUAGE, \-\-language=LANGUAGE
زبان مستندات. (نگاه کنید به \fBlanguage\fP \%<#\:confval-language>).
.UNINDENT
.INDENT 0.0
.TP
.B \-\-suffix=SUFFIX
پسوند فایل‌های سورس. (نگاه کنید به \fBsource_suffix\fP \%<#\:confval-source_suffix>).
.UNINDENT
.INDENT 0.0
.TP
.B \-\-master=MASTER
نام سند اصلی (Master). (نگاه کنید به \fBroot_doc\fP \%<#\:confval-root_doc>).
.UNINDENT
.sp
گزینه‌های افزونه‌ها
.INDENT 0.0
.TP
.B \-\-ext\-autodoc
فعال‌سازی افزونه \fBsphinx.ext.autodoc\fP \%<#\:module-sphinx\:.ext\:.autodoc>.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-ext\-doctest
فعال‌سازی افزونه \fIsphinx.ext.doctest\fP.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-ext\-intersphinx
فعال‌سازی افزونه \fIsphinx.ext.intersphinx\fP.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-ext\-todo
فعال‌سازی افزونه \fIsphinx.ext.todo\fP.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-ext\-coverage
فعال‌سازی افزونه \fIsphinx.ext.coverage\fP.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-ext\-imgmath
فعال‌سازی افزونه \fIsphinx.ext.imgmath\fP.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-ext\-mathjax
فعال‌سازی افزونه \fIsphinx.ext.mathjax\fP.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-ext\-ifconfig
فعال‌سازی افزونه \fIsphinx.ext.ifconfig\fP.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-ext\-viewcode
فعال‌سازی افزونه \fIsphinx.ext.viewcode\fP.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-ext\-githubpages
فعال‌سازی افزونه \fIsphinx.ext.githubpages\fP.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-extensions=EXTENSIONS
فعال‌سازی افزونه‌های دلخواه.
.UNINDENT
.sp
گزینه‌های ایجاد Makefile و Batchfile
.INDENT 0.0
.TP
.B \-\-use\-make\-mode (\-m), \-\-no\-use\-make\-mode (\-M)
تعیین می‌کند که \fBMakefile/make.bat\fP از make\-mode \%<#\:make-mode>\& استفاده کند (یا نکند).
پیش‌فرض \fBuse\fP است که یک \fBMakefile/make.bat\fP خلاصه‌تر تولید می‌کند.
.sp
تغییر یافته در نسخه 1.5: حالت make\-mode پیش‌فرض شد.

.sp
تغییر یافته در نسخه 7.3: پشتیبانی از غیرفعال‌سازی make\-mode در Sphinx 8 حذف خواهد شد.

.sp
حذف شده در نسخه 8.0: گزینه \fB\-\-no\-use\-make\-mode\fP حذف شد.
اکنون \fB\-\-use\-make\-mode\fP هیچ تاثیری ندارد.

.UNINDENT
.INDENT 0.0
.TP
.B \-\-makefile, \-\-no\-makefile
ایجاد (یا عدم ایجاد) makefile.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-batchfile, \-\-no\-batchfile
ایجاد (یا عدم ایجاد) batchfile.
.UNINDENT
.sp
قالب‌بندی پروژه
.sp
اضافه شده در نسخه 1.5: گزینه‌های قالب‌بندی پروژه برای sphinx\-quickstart

.INDENT 0.0
.TP
.B \-t, \-\-templatedir=TEMPLATEDIR
دایرکتوری قالب‌ها برای فایل‌های الگو. شما می‌توانید قالب‌های فایل‌های پروژه sphinx تولید شده توسط quickstart را تغییر دهید. فایل‌های قالب Jinja2 زیر مجاز هستند:
.INDENT 7.0
.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/quickstart\fP)
.UNINDENT
.INDENT 0.0
.TP
.B \-d NAME=VALUE
تعریف یک متغیر قالب
.UNINDENT
.SH "همچنین ببینید (SEE ALSO)"
.sp
\fBsphinx\-build(1)\fP
.SH "کپی‌رایت و تکثیر (COPYRIGHT)"
2007-2026, the Sphinx developers
.\" End of generated man page.