பீவேர் டாக்ஸ் கருவிகள் செயல்விளக்கம் பகுதி ஒன்று: பக்கம் இரண்டு

கால்கோடி மற்றும் வழிசெலுத்தல் இணைப்புகள்

வழிசெலுத்தல் பக்கத்தின் கீழே காட்டப்பட வேண்டும்; "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: {}

obnoxiously_long_attribute staticmethod

obnoxiously_long_attribute() -> str

Test how longer names in API docs render.

மேக்ரோ செயல்பாடு

பின்வருவது 'புருட்டஸ் சொல்கிறது "ஹலோ வேர்ல்ட்!"' என்று காட்ட வேண்டும். இது, MkDocs-Macros வழியாக வரையறுக்கப்பட்ட குளோபல் வேரியபிள்கள் மற்றும் மேக்ரோக்கள் கிடைக்கின்றன என்பதை உறுதிப்படுத்துகிறது.

Brutus கூறுகிறார் "Hello world!"