Ana içeriğe geç

BeeWare Dokümanları Araçları Demo bölümü bir: sayfa iki

Altbilgi ve gezinme bağlantıları

Navigasyon sayfanın altında görüntülenmelidir; "BeeWare Docs Tools Demo Section One" sol tarafta, "Section Two" sağ tarafta olmalıdır. Altbilgi navigasyon bağlantılarının altında olmalıdır. Bu, tema yapılandırmasının uygulandığını doğrular.

Sınıf referans belgeleri

Aşağıda, DocsTest dizininde bulunan docs_test.py sınıfı için referans belgeleri gösterilmelidir. Bu, kaynak kodu dizinine sembolik bağlantıların düzgün çalıştığını doğrular.

Parametre tablosundaki metnin, yazı tipinin geri kalanıyla aynı boyutta görüntülendiğini doğrulayın.

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

Makro işlevselliği

Aşağıda "Brutus diyor ki 'Merhaba dünya!'" yazmalıdır. Bu, MkDocs-Macros aracılığıyla tanımlanan global değişkenlerin ve makroların kullanılabilir olduğunu doğrular.

Brutus "Hello world!" diyor.