| SPHINX-QUICKSTART(1) | Sphinx | SPHINX-QUICKSTART(1) |
نام (NAME)
sphinx-quickstart - ابزار تولید قالب مستندات Sphinx
خلاصه دستور (SYNOPSIS)
sphinx-quickstart
توضیحات (DESCRIPTION)
دستور sphinx-quickstart ابزاری تعاملی است که سوالاتی درباره پروژه شما میپرسد و سپس یک دایرکتوری کامل از مستندات و یک Makefile نمونه برای استفاده با sphinx-build(1) تولید میکند.
گزینهها (OPTIONS)
- -q, --quiet
- حالت بیصدا که از ویزارد تعاملی برای تعیین گزینهها صرفنظر میکند. این گزینه به گزینههای -p، -a و -v نیاز دارد.
- -h, --help, --version
- نمایش خلاصه نحوه استفاده یا نسخه Sphinx.
گزینههای ساختار
- --sep
- در صورت تعیین، دایرکتوریهای سورس (source) و ساخت (build) را از یکدیگر جدا میکند.
- --no-sep
- در صورت تعیین، دایرکتوری ساخت را درون دایرکتوری سورس ایجاد میکند.
- --dot=DOT
- درون دایرکتوری ریشه، دو دایرکتوری دیگر ایجاد خواهد شد؛ "_templates" برای قالبهای سفارشی HTML و "_static" برای شیوهنامههای سفارشی و سایر فایلهای ایستا. میتوانید پیشوند دیگری (مانند ".") را برای جایگزینی با خط زیر (underscore) وارد کنید.
گزینههای پایهای پروژه
- -p PROJECT, --project=PROJECT
- نام پروژه تنظیم خواهد شد. (نگاه کنید به project <#confval-project>).
- -a AUTHOR, --author=AUTHOR
- نامهای نویسندگان. (نگاه کنید به copyright <#confval-copyright>).
- -v VERSION
- نسخه پروژه. (نگاه کنید به version <#confval-version>).
- -r RELEASE, --release=RELEASE
- شماره انتشار (Release) پروژه. (نگاه کنید به release <#confval-release>).
- -l LANGUAGE, --language=LANGUAGE
- زبان مستندات. (نگاه کنید به language <#confval-language>).
- --suffix=SUFFIX
- پسوند فایلهای سورس. (نگاه کنید به source_suffix <#confval-source_suffix>).
- --master=MASTER
- نام سند اصلی (Master). (نگاه کنید به root_doc <#confval-root_doc>).
گزینههای افزونهها
- --ext-autodoc
- فعالسازی افزونه sphinx.ext.autodoc <#module-sphinx.ext.autodoc>.
- --ext-doctest
- فعالسازی افزونه sphinx.ext.doctest.
- --ext-intersphinx
- فعالسازی افزونه sphinx.ext.intersphinx.
- --ext-todo
- فعالسازی افزونه sphinx.ext.todo.
- --ext-coverage
- فعالسازی افزونه sphinx.ext.coverage.
- --ext-imgmath
- فعالسازی افزونه sphinx.ext.imgmath.
- --ext-mathjax
- فعالسازی افزونه sphinx.ext.mathjax.
- --ext-ifconfig
- فعالسازی افزونه sphinx.ext.ifconfig.
- --ext-viewcode
- فعالسازی افزونه sphinx.ext.viewcode.
- --ext-githubpages
- فعالسازی افزونه sphinx.ext.githubpages.
- --extensions=EXTENSIONS
- فعالسازی افزونههای دلخواه.
گزینههای ایجاد Makefile و Batchfile
- --use-make-mode (-m), --no-use-make-mode (-M)
- تعیین
میکند که
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, --no-makefile
- ایجاد (یا عدم ایجاد) makefile.
- --batchfile, --no-batchfile
- ایجاد (یا عدم ایجاد) batchfile.
قالببندی پروژه
اضافه شده در نسخه 1.5: گزینههای قالببندی پروژه برای sphinx-quickstart
- -t, --templatedir=TEMPLATEDIR
- دایرکتوری قالبها برای فایلهای الگو. شما میتوانید قالبهای فایلهای پروژه 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)
- -d NAME=VALUE
- تعریف یک متغیر قالب
همچنین ببینید (SEE ALSO)
کپیرایت و تکثیر (COPYRIGHT)
2007-2026, the Sphinx developers
| March 4, 2026 | 9.1.0 |