├── .devcontainer ├── devcontainer.json ├── postCreate.sh └── starship.toml ├── .github ├── dependabot.yml └── workflows │ ├── ci.yaml │ ├── docs.yaml │ └── publish.yaml ├── .gitignore ├── LICENSE ├── README.md ├── config.py ├── docs ├── index.md └── usage │ ├── config.md │ ├── object.md │ ├── page.md │ └── writing.md ├── example ├── __init__.py ├── mod_a.py └── sub │ ├── __init__.py │ └── mod_b.py ├── mkdocs.yaml ├── pyproject.toml ├── src └── mkapi │ ├── __init__.py │ ├── config.py │ ├── css │ ├── mkapi-common.css │ └── mkapi-material.css │ ├── javascript │ └── mkapi.js │ ├── nav.py │ ├── page.py │ ├── parser.py │ ├── plugin.py │ ├── py.typed │ ├── renderer.py │ └── templates │ ├── document.jinja2 │ ├── heading.jinja2 │ ├── object.jinja2 │ └── source.jinja2 └── tests ├── __init__.py ├── conftest.py ├── examples ├── __init__.py ├── _styles │ ├── AUTHORS │ ├── LICENSE │ ├── __init__.py │ ├── google.py │ └── numpy.py ├── _usage.py ├── a.py ├── b.py ├── mod_a.py ├── parser.py └── sub │ ├── __init__.py │ ├── _pmod.py │ ├── mod_b.py │ ├── mod_c.py │ └── subsub │ ├── __init__.py │ └── mod_d.py ├── parser ├── __init__.py ├── test_item.py ├── test_markdown.py ├── test_merge.py ├── test_multiple_returns.py ├── test_parse.py ├── test_signature.py ├── test_summary.py └── test_yields.py ├── test_config.py ├── test_nav.py ├── test_page.py ├── test_plugin.py └── test_renderer.py /.devcontainer/devcontainer.json: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/daizutabi/mkapi/HEAD/.devcontainer/devcontainer.json -------------------------------------------------------------------------------- /.devcontainer/postCreate.sh: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/daizutabi/mkapi/HEAD/.devcontainer/postCreate.sh -------------------------------------------------------------------------------- /.devcontainer/starship.toml: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/daizutabi/mkapi/HEAD/.devcontainer/starship.toml -------------------------------------------------------------------------------- /.github/dependabot.yml: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/daizutabi/mkapi/HEAD/.github/dependabot.yml -------------------------------------------------------------------------------- /.github/workflows/ci.yaml: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/daizutabi/mkapi/HEAD/.github/workflows/ci.yaml -------------------------------------------------------------------------------- /.github/workflows/docs.yaml: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/daizutabi/mkapi/HEAD/.github/workflows/docs.yaml -------------------------------------------------------------------------------- /.github/workflows/publish.yaml: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/daizutabi/mkapi/HEAD/.github/workflows/publish.yaml -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | .coverage* 2 | .venv/ 3 | __pycache__/ 4 | dist/ 5 | lcov.info 6 | site/ 7 | uv.lock -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/daizutabi/mkapi/HEAD/LICENSE -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/daizutabi/mkapi/HEAD/README.md -------------------------------------------------------------------------------- /config.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/daizutabi/mkapi/HEAD/config.py -------------------------------------------------------------------------------- /docs/index.md: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/daizutabi/mkapi/HEAD/docs/index.md -------------------------------------------------------------------------------- /docs/usage/config.md: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/daizutabi/mkapi/HEAD/docs/usage/config.md -------------------------------------------------------------------------------- /docs/usage/object.md: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/daizutabi/mkapi/HEAD/docs/usage/object.md -------------------------------------------------------------------------------- /docs/usage/page.md: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/daizutabi/mkapi/HEAD/docs/usage/page.md -------------------------------------------------------------------------------- /docs/usage/writing.md: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/daizutabi/mkapi/HEAD/docs/usage/writing.md -------------------------------------------------------------------------------- /example/__init__.py: -------------------------------------------------------------------------------- 1 | """Example package.""" 2 | -------------------------------------------------------------------------------- /example/mod_a.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/daizutabi/mkapi/HEAD/example/mod_a.py -------------------------------------------------------------------------------- /example/sub/__init__.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/daizutabi/mkapi/HEAD/example/sub/__init__.py -------------------------------------------------------------------------------- /example/sub/mod_b.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/daizutabi/mkapi/HEAD/example/sub/mod_b.py -------------------------------------------------------------------------------- /mkdocs.yaml: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/daizutabi/mkapi/HEAD/mkdocs.yaml -------------------------------------------------------------------------------- /pyproject.toml: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/daizutabi/mkapi/HEAD/pyproject.toml -------------------------------------------------------------------------------- /src/mkapi/__init__.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/daizutabi/mkapi/HEAD/src/mkapi/__init__.py -------------------------------------------------------------------------------- /src/mkapi/config.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/daizutabi/mkapi/HEAD/src/mkapi/config.py -------------------------------------------------------------------------------- /src/mkapi/css/mkapi-common.css: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/daizutabi/mkapi/HEAD/src/mkapi/css/mkapi-common.css -------------------------------------------------------------------------------- /src/mkapi/css/mkapi-material.css: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/daizutabi/mkapi/HEAD/src/mkapi/css/mkapi-material.css -------------------------------------------------------------------------------- /src/mkapi/javascript/mkapi.js: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/daizutabi/mkapi/HEAD/src/mkapi/javascript/mkapi.js -------------------------------------------------------------------------------- /src/mkapi/nav.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/daizutabi/mkapi/HEAD/src/mkapi/nav.py -------------------------------------------------------------------------------- /src/mkapi/page.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/daizutabi/mkapi/HEAD/src/mkapi/page.py -------------------------------------------------------------------------------- /src/mkapi/parser.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/daizutabi/mkapi/HEAD/src/mkapi/parser.py -------------------------------------------------------------------------------- /src/mkapi/plugin.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/daizutabi/mkapi/HEAD/src/mkapi/plugin.py -------------------------------------------------------------------------------- /src/mkapi/py.typed: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /src/mkapi/renderer.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/daizutabi/mkapi/HEAD/src/mkapi/renderer.py -------------------------------------------------------------------------------- /src/mkapi/templates/document.jinja2: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/daizutabi/mkapi/HEAD/src/mkapi/templates/document.jinja2 -------------------------------------------------------------------------------- /src/mkapi/templates/heading.jinja2: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/daizutabi/mkapi/HEAD/src/mkapi/templates/heading.jinja2 -------------------------------------------------------------------------------- /src/mkapi/templates/object.jinja2: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/daizutabi/mkapi/HEAD/src/mkapi/templates/object.jinja2 -------------------------------------------------------------------------------- /src/mkapi/templates/source.jinja2: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/daizutabi/mkapi/HEAD/src/mkapi/templates/source.jinja2 -------------------------------------------------------------------------------- /tests/__init__.py: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /tests/conftest.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/daizutabi/mkapi/HEAD/tests/conftest.py -------------------------------------------------------------------------------- /tests/examples/__init__.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/daizutabi/mkapi/HEAD/tests/examples/__init__.py -------------------------------------------------------------------------------- /tests/examples/_styles/AUTHORS: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/daizutabi/mkapi/HEAD/tests/examples/_styles/AUTHORS -------------------------------------------------------------------------------- /tests/examples/_styles/LICENSE: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/daizutabi/mkapi/HEAD/tests/examples/_styles/LICENSE -------------------------------------------------------------------------------- /tests/examples/_styles/__init__.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/daizutabi/mkapi/HEAD/tests/examples/_styles/__init__.py -------------------------------------------------------------------------------- /tests/examples/_styles/google.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/daizutabi/mkapi/HEAD/tests/examples/_styles/google.py -------------------------------------------------------------------------------- /tests/examples/_styles/numpy.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/daizutabi/mkapi/HEAD/tests/examples/_styles/numpy.py -------------------------------------------------------------------------------- /tests/examples/_usage.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/daizutabi/mkapi/HEAD/tests/examples/_usage.py -------------------------------------------------------------------------------- /tests/examples/a.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/daizutabi/mkapi/HEAD/tests/examples/a.py -------------------------------------------------------------------------------- /tests/examples/b.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/daizutabi/mkapi/HEAD/tests/examples/b.py -------------------------------------------------------------------------------- /tests/examples/mod_a.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/daizutabi/mkapi/HEAD/tests/examples/mod_a.py -------------------------------------------------------------------------------- /tests/examples/parser.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/daizutabi/mkapi/HEAD/tests/examples/parser.py -------------------------------------------------------------------------------- /tests/examples/sub/__init__.py: -------------------------------------------------------------------------------- 1 | """A subpackage""" 2 | -------------------------------------------------------------------------------- /tests/examples/sub/_pmod.py: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /tests/examples/sub/mod_b.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/daizutabi/mkapi/HEAD/tests/examples/sub/mod_b.py -------------------------------------------------------------------------------- /tests/examples/sub/mod_c.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/daizutabi/mkapi/HEAD/tests/examples/sub/mod_c.py -------------------------------------------------------------------------------- /tests/examples/sub/subsub/__init__.py: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /tests/examples/sub/subsub/mod_d.py: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /tests/parser/__init__.py: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /tests/parser/test_item.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/daizutabi/mkapi/HEAD/tests/parser/test_item.py -------------------------------------------------------------------------------- /tests/parser/test_markdown.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/daizutabi/mkapi/HEAD/tests/parser/test_markdown.py -------------------------------------------------------------------------------- /tests/parser/test_merge.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/daizutabi/mkapi/HEAD/tests/parser/test_merge.py -------------------------------------------------------------------------------- /tests/parser/test_multiple_returns.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/daizutabi/mkapi/HEAD/tests/parser/test_multiple_returns.py -------------------------------------------------------------------------------- /tests/parser/test_parse.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/daizutabi/mkapi/HEAD/tests/parser/test_parse.py -------------------------------------------------------------------------------- /tests/parser/test_signature.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/daizutabi/mkapi/HEAD/tests/parser/test_signature.py -------------------------------------------------------------------------------- /tests/parser/test_summary.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/daizutabi/mkapi/HEAD/tests/parser/test_summary.py -------------------------------------------------------------------------------- /tests/parser/test_yields.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/daizutabi/mkapi/HEAD/tests/parser/test_yields.py -------------------------------------------------------------------------------- /tests/test_config.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/daizutabi/mkapi/HEAD/tests/test_config.py -------------------------------------------------------------------------------- /tests/test_nav.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/daizutabi/mkapi/HEAD/tests/test_nav.py -------------------------------------------------------------------------------- /tests/test_page.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/daizutabi/mkapi/HEAD/tests/test_page.py -------------------------------------------------------------------------------- /tests/test_plugin.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/daizutabi/mkapi/HEAD/tests/test_plugin.py -------------------------------------------------------------------------------- /tests/test_renderer.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/daizutabi/mkapi/HEAD/tests/test_renderer.py --------------------------------------------------------------------------------