انتقل إلى المحتوى

أدوات BeeWare Docs العرض التوضيحي القسم الأول: الصفحة الثانية

روابط التذييل والتنقل

يجب أن تظهر أداة التنقل في أسفل الصفحة؛ يجب أن يكون "BeeWare Docs Tools Demo Section One" على اليسار، و"Section Two" على اليمين. يجب أن يكون التذييل أسفل روابط التنقل. هذا يؤكد أن تكوين السمة قد تم تطبيقه.

وثائق مرجعية للفئة

يجب أن يظهر ما يلي الوثائق المرجعية لفئة DocsTest الموجودة في docs_test.py في دليل src/beeware_docs_tools. وهذا يؤكد أن الارتباط الرمزي لدليل شفرة المصدر يعمل بشكل صحيح.

تحقق من أن النص في جدول المعلمات يتم عرضه بنفس حجم باقي الخط.

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: {}

وظائف الماكرو

يجب أن يكون النص التالي "Brutus says "Hello world!"". وهذا يؤكد أن المتغيرات العالمية والماكروات المحددة عبر MkDocs-Macros متاحة.

Brutus يقول "Hello world!"