نام (NAME)

sphinx-autogen - تولید صفحات ساختگی (stub) برای autodoc

خلاصه دستور (SYNOPSIS)

sphinx-autogen [options] <sourcefile> ...

توضیحات (DESCRIPTION)

sphinx-autogen ابزاری برای تولید خودکار منابع Sphinx است که با استفاده از افزونه‌ی autodoc <#module-sphinx.ext.autodoc>، مواردی را که در فهرست(های) autosummary <#directive-autosummary> قرار دارند مستندسازی می‌کند.

sourcefile مسیر یک یا چند سند reStructuredText است که شامل مدخل‌های autosummary <#directive-autosummary> همراه با گزینه‌ی تنظیم‌شده‌ی :toctree: هستند. sourcefile می‌تواند الگویی با سبک fnmatch https://docs.python.org/3/library/fnmatch.html#module-fnmatch باشد.

گزینه‌ها (OPTIONS)

مثال‌ها (EXAMPLES)

با فرض ساختار دایرکتوری زیر:

docs
├── index.rst
└── ...
foobar
├── foo
│   └── __init__.py
└── bar
    ├── __init__.py
    └── baz
        └── __init__.py

و با فرض اینکه docs/index.rst شامل موارد زیر باشد:

Modules
=======
.. autosummary::
   :toctree: modules
   foobar.foo
   foobar.bar
   foobar.bar.baz

اگر دستور زیر را اجرا کنید:

$ PYTHONPATH=. sphinx-autogen docs/index.rst

آنگاه فایل‌های ساختگی (stub) زیر در docs ایجاد خواهند شد:

docs
├── index.rst
└── modules
    ├── foobar.bar.rst
    ├── foobar.bar.baz.rst
    └── foobar.foo.rst

و هر یک از این فایل‌ها شامل یک دستورالعمل autodoc <#module-sphinx.ext.autodoc> و برخی اطلاعات دیگر خواهند بود.

همچنین ببینید (SEE ALSO)

sphinx-build(1), sphinx-apidoc(1)

کپی‌رایت و تکثیر (COPYRIGHT)

2007-2026، توسعه‌دهندگان Sphinx