Skip to content

اضافه کردن توضیحات و جزئیات بیشتر برای متد ها #120

Description

@kian-ahmadian

برای اضافه کردن جزئیات بیشتر و نمایش بهتر داکیومنت از افزونه های زیر استفاده شده است:

  • sphinx-paramlinks==0.6.0
  • sphinxcontrib-mermaid==0.8.1
  • sphinx-copybutton==0.5.2
  • sphinx-inline-tabs==2023.4.21
  • sphinx-autodoc-typehints==1.23.0
  • sphinxcontrib-video==0.2.1
  • sphinx-reredirects==0.1.5
  • sphinxcontrib_trio==1.1.2

در جزئیات جدید تایپ هینت های موجود در داخل کد در پارامتر ها و مقادیر بازگشتی به طور کامل نیز در مستندات قرار میگیرند

همچنین در هر یک از کلاس های موجود در داکیومنتی، لینکی به سوی مستندات بله (در صورت وجود داشتن آن کلاس در مستندات بله) نیز الصاق شده است

Metadata

Metadata

Labels

documentation 🗒️Improvements or additions to documentationenhancement 🔧New feature or requestevents sectionPRs related to the event section.handlers sectionPRs related to the handler section.persianPeople inside the issue speak in persian languageupdater sectionPRs related to the updater section.

Type

No type
No fields configured for issues without a type.

Projects

Status
In progress

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions