بخش دمو ابزارهای مستندسازی BeeWare: صفحهٔ دوم

پاورقی و پیوندهای ناوبری

ناوبری باید در پایین صفحه نمایش داده شود؛ «BeeWare Docs Tools Demo Section One» باید در سمت چپ و «Section Two» باید در سمت راست قرار گیرد. فوتر باید زیر لینک‌های ناوبری باشد. این تأیید می‌کند که پیکربندی تم اعمال شده است.

مستندات مرجع کلاس

دستور زیر باید مستندات مرجع کلاس DocsTest را که در دایرکتوری docs_test.py قرار دارد، نمایش دهد. این کار تأیید می‌کند که لینک‌سymbolی دایرکتوری‌های سورس کد به‌درستی کار می‌کند.

تأیید کنید که متن در جدول پارامترها با همان اندازهٔ سایر قسمت‌های قلم نمایش داده می‌شود.

beeware_docs_tools.docs_test.DocsTest

DocsTest(arg1: int, arg2: int = 42, **kwargs)

This is the test class.

PARAMETER	DESCRIPTION
arg1	A value. TYPE: int
arg2	A value with a default. TYPE: int DEFAULT: 42
kwargs	keyword arguments DEFAULT: {}

attribute property

attribute: int

This is a test attribute.

method

method(arg1: int, arg2: int = 42, **kwargs)

This is a test method.

PARAMETER	DESCRIPTION
arg1	A value. TYPE: int
arg2	A value with a default. TYPE: int DEFAULT: 42
kwargs	keyword arguments DEFAULT: {}

obnoxiously_long_attribute staticmethod

obnoxiously_long_attribute() -> str

Test how longer names in API docs render.

کارکرد ماکرو

خروجی زیر باید عبارت «Brutus می‌گوید "Hello world!"» را نمایش دهد. این تأیید می‌کند که متغیرهای سراسری و ماکروهای تعریف‌شده از طریق MkDocs-Macros در دسترس هستند.

Brutus می‌گوید «Hello world!»