nb-autodoc 0.1.0

API doc generator for NoneBot.

nb-autodoc

������

��������� NoneBot ��� API ���������������������������������������������������������������

��������������������������������������������������������������������������������������� Google Style Docstring ��� Docstring ������������������������������������������������������

������������������ nb-autodoc ��������� ast ������������������ stub file ������������������������������������

Cheat Sheet

������������

Module

"""
description.

FrontMatter:
    sidebar: auto
    option:
        (anything nested)
"""

������: FrontMatter ������������ description ���������

Class

"""
������:
    name: desc
    kwargs: other desc

������:
    attr1: desc
"""

__init__ ������������������������������������������������ docstring ������������������

������������������������������������������������

Function

"""
������:
    name: desc, case in ['case1', 'case2']
        - `case1`: desc
        - `case2`: desc
    name2 (Union[pkg.foo.Foo, str]): desc

������:
    Optional[pkg.foo.Foo]: ������

������:
    ```python
    print('hello world!')
    ```
    ������������
"""

������������������������������������������������������������������������������������������������������������ url link���

���������������������������������������������������������������������������������

������������������������������������������������������������ ^(?! )([\w\.\[\], ]+)(?: *\(([\w\.\[\], ]+)\))?(.*?): ������������������������������������������������������������ annotation ������ url link ������������������������������������

Variable

������������������������

������������

������: 1.1.0+

������ (1.1.0+):
    name (annotation) {version}`1.1.0+`: desc

������������Variable ������������������������������������

������������: 1.1.0+

���������������������

• version

  {version}`1.1.0+`
  

• ref

  {ref}`pkg.foo.Foo`
  

������������������

��������������� __autodoc__ ������������������������������������������������������������������������������������ True ������ False���

���:

__autodoc__ = {
    "MyClass": True,
    "MyClass.attr": False
}

������������������������������������������������ docstring���������������������������������������������������

������: ��������������������������������������������� True ��������������������������������������� stub file ���������������

Schedule

1. reduce code redundancy

2. ���������������������������������������������������������������������������������������������������������������

3. ������������������

4. ������������������

Development Roadmap

• 1.0

  • ������ AST ��������������������������������������������������������� import_module ��������������������������������������������������������������������������������������������� docstring ���������������������������������������������������������������������������������

  • ������ AST ������ if TYPE_CHECKING ��������� import ��� importfrom (performance relative import) ��������������������������� attributes dict��������������� get_type_hints������������������������������������ callable ���������

  • ��������� pyi ������������������������ overload ���������������