├── .github ├── actions │ └── setup-python │ │ └── action.yml └── workflows │ └── test.yml ├── .gitignore ├── .prettierignore ├── .vscode ├── launch.json └── settings.json ├── LICENSE ├── README.md ├── README_en.md ├── logo └── logo.png ├── mypy.ini ├── nb_autodoc ├── __init__.py ├── __main__.py ├── analyzers │ ├── __init__.py │ ├── analyzer.py │ ├── base.py │ ├── definitionfinder.py │ ├── unparse_ann.py │ └── utils.py ├── annotation.py ├── builders │ ├── __init__.py │ ├── helpers.py │ └── markdown.py ├── config.py ├── docstringparser │ ├── __init__.py │ └── google.py ├── log.py ├── manager.py ├── modulefinder.py ├── nodes.py ├── py.typed ├── typing.py └── utils.py ├── pdm.lock ├── pyproject.toml └── tests ├── __init__.py ├── analyzerdata ├── assigndata-override-ast.py ├── exec_type_checking.py ├── extract-docstring.py ├── overload.py ├── simple-definition-ast.py └── type-checking-ast.py ├── data ├── __init__.py ├── example_google_docstring.py └── stuff1.py ├── managerdata ├── class_bases │ ├── __init__.py │ └── base.py ├── class_instvar_combination.py ├── class_prepare │ ├── __init__.py │ └── instvar.py ├── get_canonical_member │ ├── Foo.py │ ├── __init__.py │ ├── a.py │ └── b.py ├── single.py └── variable_is_typealias.py ├── modulefinderdata └── simplepkg │ ├── __init__.py │ ├── foo.py │ ├── foo.pyi │ ├── simplenamespace │ ├── portion1.py │ ├── portion1.pyi │ └── portion2 │ │ └── __init__.py │ ├── stubalone.pyi │ ├── sub.py │ ├── sub.pyi │ └── sub │ ├── __init__.py │ ├── __init__.pyi │ ├── a.py │ ├── a.pyi │ └── stubalone.pyi ├── simple_pkg ├── __init__.py ├── api.py ├── namespace │ └── foo.py ├── overload │ ├── __init__.py │ ├── __init__.pyi │ ├── nopyi.py │ ├── relative.py │ └── typing.py ├── pyi │ ├── __init__.py │ ├── fuzz.py │ ├── fuzz.pyi │ └── util.py ├── reexport │ ├── __init__.py │ ├── _sample.py │ └── inter.py └── typing.py ├── test_analyzers ├── __init__.py ├── test_analyzer.py ├── test_definitionfinder.py ├── test_unparse_ann.py └── test_utils.py ├── test_annotation.py ├── test_docstringparser ├── __init__.py └── test_google.py ├── test_manager.py ├── test_modulefinder.py ├── test_utils.py └── utils.py /.github/actions/setup-python/action.yml: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/nonebot/nb-autodoc/HEAD/.github/actions/setup-python/action.yml -------------------------------------------------------------------------------- /.github/workflows/test.yml: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/nonebot/nb-autodoc/HEAD/.github/workflows/test.yml -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/nonebot/nb-autodoc/HEAD/.gitignore -------------------------------------------------------------------------------- /.prettierignore: -------------------------------------------------------------------------------- 1 | *.md -------------------------------------------------------------------------------- /.vscode/launch.json: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/nonebot/nb-autodoc/HEAD/.vscode/launch.json -------------------------------------------------------------------------------- /.vscode/settings.json: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/nonebot/nb-autodoc/HEAD/.vscode/settings.json -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/nonebot/nb-autodoc/HEAD/LICENSE -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/nonebot/nb-autodoc/HEAD/README.md -------------------------------------------------------------------------------- /README_en.md: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/nonebot/nb-autodoc/HEAD/README_en.md -------------------------------------------------------------------------------- /logo/logo.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/nonebot/nb-autodoc/HEAD/logo/logo.png -------------------------------------------------------------------------------- /mypy.ini: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/nonebot/nb-autodoc/HEAD/mypy.ini -------------------------------------------------------------------------------- /nb_autodoc/__init__.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/nonebot/nb-autodoc/HEAD/nb_autodoc/__init__.py -------------------------------------------------------------------------------- /nb_autodoc/__main__.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/nonebot/nb-autodoc/HEAD/nb_autodoc/__main__.py -------------------------------------------------------------------------------- /nb_autodoc/analyzers/__init__.py: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /nb_autodoc/analyzers/analyzer.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/nonebot/nb-autodoc/HEAD/nb_autodoc/analyzers/analyzer.py -------------------------------------------------------------------------------- /nb_autodoc/analyzers/base.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/nonebot/nb-autodoc/HEAD/nb_autodoc/analyzers/base.py -------------------------------------------------------------------------------- /nb_autodoc/analyzers/definitionfinder.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/nonebot/nb-autodoc/HEAD/nb_autodoc/analyzers/definitionfinder.py -------------------------------------------------------------------------------- /nb_autodoc/analyzers/unparse_ann.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/nonebot/nb-autodoc/HEAD/nb_autodoc/analyzers/unparse_ann.py -------------------------------------------------------------------------------- /nb_autodoc/analyzers/utils.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/nonebot/nb-autodoc/HEAD/nb_autodoc/analyzers/utils.py -------------------------------------------------------------------------------- /nb_autodoc/annotation.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/nonebot/nb-autodoc/HEAD/nb_autodoc/annotation.py -------------------------------------------------------------------------------- /nb_autodoc/builders/__init__.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/nonebot/nb-autodoc/HEAD/nb_autodoc/builders/__init__.py -------------------------------------------------------------------------------- /nb_autodoc/builders/helpers.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/nonebot/nb-autodoc/HEAD/nb_autodoc/builders/helpers.py -------------------------------------------------------------------------------- /nb_autodoc/builders/markdown.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/nonebot/nb-autodoc/HEAD/nb_autodoc/builders/markdown.py -------------------------------------------------------------------------------- /nb_autodoc/config.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/nonebot/nb-autodoc/HEAD/nb_autodoc/config.py -------------------------------------------------------------------------------- /nb_autodoc/docstringparser/__init__.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/nonebot/nb-autodoc/HEAD/nb_autodoc/docstringparser/__init__.py -------------------------------------------------------------------------------- /nb_autodoc/docstringparser/google.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/nonebot/nb-autodoc/HEAD/nb_autodoc/docstringparser/google.py -------------------------------------------------------------------------------- /nb_autodoc/log.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/nonebot/nb-autodoc/HEAD/nb_autodoc/log.py -------------------------------------------------------------------------------- /nb_autodoc/manager.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/nonebot/nb-autodoc/HEAD/nb_autodoc/manager.py -------------------------------------------------------------------------------- /nb_autodoc/modulefinder.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/nonebot/nb-autodoc/HEAD/nb_autodoc/modulefinder.py -------------------------------------------------------------------------------- /nb_autodoc/nodes.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/nonebot/nb-autodoc/HEAD/nb_autodoc/nodes.py -------------------------------------------------------------------------------- /nb_autodoc/py.typed: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /nb_autodoc/typing.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/nonebot/nb-autodoc/HEAD/nb_autodoc/typing.py -------------------------------------------------------------------------------- /nb_autodoc/utils.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/nonebot/nb-autodoc/HEAD/nb_autodoc/utils.py -------------------------------------------------------------------------------- /pdm.lock: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/nonebot/nb-autodoc/HEAD/pdm.lock -------------------------------------------------------------------------------- /pyproject.toml: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/nonebot/nb-autodoc/HEAD/pyproject.toml -------------------------------------------------------------------------------- /tests/__init__.py: -------------------------------------------------------------------------------- 1 | # for mypy package recognize 2 | -------------------------------------------------------------------------------- /tests/analyzerdata/assigndata-override-ast.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/nonebot/nb-autodoc/HEAD/tests/analyzerdata/assigndata-override-ast.py -------------------------------------------------------------------------------- /tests/analyzerdata/exec_type_checking.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/nonebot/nb-autodoc/HEAD/tests/analyzerdata/exec_type_checking.py -------------------------------------------------------------------------------- /tests/analyzerdata/extract-docstring.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/nonebot/nb-autodoc/HEAD/tests/analyzerdata/extract-docstring.py -------------------------------------------------------------------------------- /tests/analyzerdata/overload.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/nonebot/nb-autodoc/HEAD/tests/analyzerdata/overload.py -------------------------------------------------------------------------------- /tests/analyzerdata/simple-definition-ast.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/nonebot/nb-autodoc/HEAD/tests/analyzerdata/simple-definition-ast.py -------------------------------------------------------------------------------- /tests/analyzerdata/type-checking-ast.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/nonebot/nb-autodoc/HEAD/tests/analyzerdata/type-checking-ast.py -------------------------------------------------------------------------------- /tests/data/__init__.py: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /tests/data/example_google_docstring.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/nonebot/nb-autodoc/HEAD/tests/data/example_google_docstring.py -------------------------------------------------------------------------------- /tests/data/stuff1.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/nonebot/nb-autodoc/HEAD/tests/data/stuff1.py -------------------------------------------------------------------------------- /tests/managerdata/class_bases/__init__.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/nonebot/nb-autodoc/HEAD/tests/managerdata/class_bases/__init__.py -------------------------------------------------------------------------------- /tests/managerdata/class_bases/base.py: -------------------------------------------------------------------------------- 1 | class Base: 2 | ... 3 | -------------------------------------------------------------------------------- /tests/managerdata/class_instvar_combination.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/nonebot/nb-autodoc/HEAD/tests/managerdata/class_instvar_combination.py -------------------------------------------------------------------------------- /tests/managerdata/class_prepare/__init__.py: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /tests/managerdata/class_prepare/instvar.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/nonebot/nb-autodoc/HEAD/tests/managerdata/class_prepare/instvar.py -------------------------------------------------------------------------------- /tests/managerdata/get_canonical_member/Foo.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/nonebot/nb-autodoc/HEAD/tests/managerdata/get_canonical_member/Foo.py -------------------------------------------------------------------------------- /tests/managerdata/get_canonical_member/__init__.py: -------------------------------------------------------------------------------- 1 | class Foo: 2 | a = 1 3 | -------------------------------------------------------------------------------- /tests/managerdata/get_canonical_member/a.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/nonebot/nb-autodoc/HEAD/tests/managerdata/get_canonical_member/a.py -------------------------------------------------------------------------------- /tests/managerdata/get_canonical_member/b.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/nonebot/nb-autodoc/HEAD/tests/managerdata/get_canonical_member/b.py -------------------------------------------------------------------------------- /tests/managerdata/single.py: -------------------------------------------------------------------------------- 1 | foo = 1 2 | 3 | 4 | def func() -> str: 5 | ... 6 | -------------------------------------------------------------------------------- /tests/managerdata/variable_is_typealias.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/nonebot/nb-autodoc/HEAD/tests/managerdata/variable_is_typealias.py -------------------------------------------------------------------------------- /tests/modulefinderdata/simplepkg/__init__.py: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /tests/modulefinderdata/simplepkg/foo.py: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /tests/modulefinderdata/simplepkg/foo.pyi: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /tests/modulefinderdata/simplepkg/simplenamespace/portion1.py: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /tests/modulefinderdata/simplepkg/simplenamespace/portion1.pyi: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /tests/modulefinderdata/simplepkg/simplenamespace/portion2/__init__.py: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /tests/modulefinderdata/simplepkg/stubalone.pyi: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /tests/modulefinderdata/simplepkg/sub.py: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /tests/modulefinderdata/simplepkg/sub.pyi: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /tests/modulefinderdata/simplepkg/sub/__init__.py: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /tests/modulefinderdata/simplepkg/sub/__init__.pyi: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /tests/modulefinderdata/simplepkg/sub/a.py: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /tests/modulefinderdata/simplepkg/sub/a.pyi: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /tests/modulefinderdata/simplepkg/sub/stubalone.pyi: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /tests/simple_pkg/__init__.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/nonebot/nb-autodoc/HEAD/tests/simple_pkg/__init__.py -------------------------------------------------------------------------------- /tests/simple_pkg/api.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/nonebot/nb-autodoc/HEAD/tests/simple_pkg/api.py -------------------------------------------------------------------------------- /tests/simple_pkg/namespace/foo.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/nonebot/nb-autodoc/HEAD/tests/simple_pkg/namespace/foo.py -------------------------------------------------------------------------------- /tests/simple_pkg/overload/__init__.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/nonebot/nb-autodoc/HEAD/tests/simple_pkg/overload/__init__.py -------------------------------------------------------------------------------- /tests/simple_pkg/overload/__init__.pyi: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/nonebot/nb-autodoc/HEAD/tests/simple_pkg/overload/__init__.pyi -------------------------------------------------------------------------------- /tests/simple_pkg/overload/nopyi.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/nonebot/nb-autodoc/HEAD/tests/simple_pkg/overload/nopyi.py -------------------------------------------------------------------------------- /tests/simple_pkg/overload/relative.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/nonebot/nb-autodoc/HEAD/tests/simple_pkg/overload/relative.py -------------------------------------------------------------------------------- /tests/simple_pkg/overload/typing.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/nonebot/nb-autodoc/HEAD/tests/simple_pkg/overload/typing.py -------------------------------------------------------------------------------- /tests/simple_pkg/pyi/__init__.py: -------------------------------------------------------------------------------- 1 | """test for pyi""" 2 | -------------------------------------------------------------------------------- /tests/simple_pkg/pyi/fuzz.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/nonebot/nb-autodoc/HEAD/tests/simple_pkg/pyi/fuzz.py -------------------------------------------------------------------------------- /tests/simple_pkg/pyi/fuzz.pyi: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/nonebot/nb-autodoc/HEAD/tests/simple_pkg/pyi/fuzz.pyi -------------------------------------------------------------------------------- /tests/simple_pkg/pyi/util.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/nonebot/nb-autodoc/HEAD/tests/simple_pkg/pyi/util.py -------------------------------------------------------------------------------- /tests/simple_pkg/reexport/__init__.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/nonebot/nb-autodoc/HEAD/tests/simple_pkg/reexport/__init__.py -------------------------------------------------------------------------------- /tests/simple_pkg/reexport/_sample.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/nonebot/nb-autodoc/HEAD/tests/simple_pkg/reexport/_sample.py -------------------------------------------------------------------------------- /tests/simple_pkg/reexport/inter.py: -------------------------------------------------------------------------------- 1 | from ._sample import A as inter_A 2 | -------------------------------------------------------------------------------- /tests/simple_pkg/typing.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/nonebot/nb-autodoc/HEAD/tests/simple_pkg/typing.py -------------------------------------------------------------------------------- /tests/test_analyzers/__init__.py: -------------------------------------------------------------------------------- 1 | # help mypy exclude this package 2 | -------------------------------------------------------------------------------- /tests/test_analyzers/test_analyzer.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/nonebot/nb-autodoc/HEAD/tests/test_analyzers/test_analyzer.py -------------------------------------------------------------------------------- /tests/test_analyzers/test_definitionfinder.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/nonebot/nb-autodoc/HEAD/tests/test_analyzers/test_definitionfinder.py -------------------------------------------------------------------------------- /tests/test_analyzers/test_unparse_ann.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/nonebot/nb-autodoc/HEAD/tests/test_analyzers/test_unparse_ann.py -------------------------------------------------------------------------------- /tests/test_analyzers/test_utils.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/nonebot/nb-autodoc/HEAD/tests/test_analyzers/test_utils.py -------------------------------------------------------------------------------- /tests/test_annotation.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/nonebot/nb-autodoc/HEAD/tests/test_annotation.py -------------------------------------------------------------------------------- /tests/test_docstringparser/__init__.py: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /tests/test_docstringparser/test_google.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/nonebot/nb-autodoc/HEAD/tests/test_docstringparser/test_google.py -------------------------------------------------------------------------------- /tests/test_manager.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/nonebot/nb-autodoc/HEAD/tests/test_manager.py -------------------------------------------------------------------------------- /tests/test_modulefinder.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/nonebot/nb-autodoc/HEAD/tests/test_modulefinder.py -------------------------------------------------------------------------------- /tests/test_utils.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/nonebot/nb-autodoc/HEAD/tests/test_utils.py -------------------------------------------------------------------------------- /tests/utils.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/nonebot/nb-autodoc/HEAD/tests/utils.py --------------------------------------------------------------------------------