SPHINX-QUICKSTART(1) Sphinx SPHINX-QUICKSTART(1)

sphinx-quickstart - ابزار تولید قالب مستندات Sphinx

sphinx-quickstart

دستور sphinx-quickstart ابزاری تعاملی است که سوالاتی درباره پروژه شما می‌پرسد و سپس یک دایرکتوری کامل از مستندات و یک Makefile نمونه برای استفاده با sphinx-build(1) تولید می‌کند.

حالت بی‌صدا که از ویزارد تعاملی برای تعیین گزینه‌ها صرف‌نظر می‌کند. این گزینه به گزینه‌های -p، -a و -v نیاز دارد.
نمایش خلاصه نحوه استفاده یا نسخه Sphinx.

گزینه‌های ساختار

در صورت تعیین، دایرکتوری‌های سورس (source) و ساخت (build) را از یکدیگر جدا می‌کند.
در صورت تعیین، دایرکتوری ساخت را درون دایرکتوری سورس ایجاد می‌کند.
درون دایرکتوری ریشه، دو دایرکتوری دیگر ایجاد خواهد شد؛ "_templates" برای قالب‌های سفارشی HTML و "_static" برای شیوه‌نامه‌های سفارشی و سایر فایل‌های ایستا. می‌توانید پیشوند دیگری (مانند ".") را برای جایگزینی با خط زیر (underscore) وارد کنید.

گزینه‌های پایه‌ای پروژه

نام پروژه تنظیم خواهد شد. (نگاه کنید به project <#confval-project>).
نام‌های نویسندگان. (نگاه کنید به copyright <#confval-copyright>).
نسخه پروژه. (نگاه کنید به version <#confval-version>).
شماره انتشار (Release) پروژه. (نگاه کنید به release <#confval-release>).
زبان مستندات. (نگاه کنید به language <#confval-language>).
پسوند فایل‌های سورس. (نگاه کنید به source_suffix <#confval-source_suffix>).
نام سند اصلی (Master). (نگاه کنید به root_doc <#confval-root_doc>).

گزینه‌های افزونه‌ها

فعال‌سازی افزونه sphinx.ext.autodoc <#module-sphinx.ext.autodoc>.
فعال‌سازی افزونه sphinx.ext.doctest.
فعال‌سازی افزونه sphinx.ext.intersphinx.
فعال‌سازی افزونه sphinx.ext.todo.
فعال‌سازی افزونه sphinx.ext.coverage.
فعال‌سازی افزونه sphinx.ext.imgmath.
فعال‌سازی افزونه sphinx.ext.mathjax.
فعال‌سازی افزونه sphinx.ext.ifconfig.
فعال‌سازی افزونه sphinx.ext.viewcode.
فعال‌سازی افزونه sphinx.ext.githubpages.
فعال‌سازی افزونه‌های دلخواه.

گزینه‌های ایجاد Makefile و Batchfile

تعیین می‌کند که Makefile/make.bat از make-mode <#make-mode> استفاده کند (یا نکند). پیش‌فرض use است که یک Makefile/make.bat خلاصه‌تر تولید می‌کند.

تغییر یافته در نسخه 1.5: حالت make-mode پیش‌فرض شد.

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

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

ایجاد (یا عدم ایجاد) makefile.
ایجاد (یا عدم ایجاد) batchfile.

قالب‌بندی پروژه

اضافه شده در نسخه 1.5: گزینه‌های قالب‌بندی پروژه برای sphinx-quickstart

دایرکتوری قالب‌ها برای فایل‌های الگو. شما می‌توانید قالب‌های فایل‌های پروژه sphinx تولید شده توسط quickstart را تغییر دهید. فایل‌های قالب Jinja2 زیر مجاز هستند:
  • root_doc.rst.jinja
  • conf.py.jinja
  • Makefile.jinja
  • Makefile.new.jinja
  • make.bat.jinja
  • make.bat.new.jinja

برای جزئیات بیشتر، لطفاً به فایل‌های قالب سیستمی که Sphinx ارائه می‌دهد مراجعه کنید. (sphinx/templates/quickstart)

تعریف یک متغیر قالب

sphinx-build(1)

2007-2026, the Sphinx developers

March 4, 2026 9.1.0