{"id":14065464,"url":"https://github.com/daizutabi/mkapi","last_synced_at":"2025-07-29T20:32:51.051Z","repository":{"id":42173433,"uuid":"256942527","full_name":"daizutabi/mkapi","owner":"daizutabi","description":"A plugin for MkDocs to generate API documentation","archived":false,"fork":false,"pushed_at":"2024-10-15T09:40:03.000Z","size":8508,"stargazers_count":104,"open_issues_count":3,"forks_count":19,"subscribers_count":2,"default_branch":"main","last_synced_at":"2024-11-17T13:57:54.555Z","etag":null,"topics":["api-documentation","markdown","mkdocs-plugin"],"latest_commit_sha":null,"homepage":"https://daizutabi.github.io/mkapi/","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/daizutabi.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2020-04-19T07:43:40.000Z","updated_at":"2024-11-14T03:49:27.000Z","dependencies_parsed_at":"2024-01-01T03:35:28.074Z","dependency_job_id":"f26bebba-4336-4434-8499-cc04525b8868","html_url":"https://github.com/daizutabi/mkapi","commit_stats":null,"previous_names":[],"tags_count":63,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/daizutabi%2Fmkapi","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/daizutabi%2Fmkapi/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/daizutabi%2Fmkapi/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/daizutabi%2Fmkapi/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/daizutabi","download_url":"https://codeload.github.com/daizutabi/mkapi/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":228046152,"owners_count":17861101,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["api-documentation","markdown","mkdocs-plugin"],"created_at":"2024-08-13T07:04:30.380Z","updated_at":"2025-07-29T20:32:51.018Z","avatar_url":"https://github.com/daizutabi.png","language":"Python","funding_links":[],"categories":["Python"],"sub_categories":[],"readme":"# MkAPI\n\n[![PyPI Version][pypi-v-image]][pypi-v-link]\n[![Python Version][python-v-image]][python-v-link]\n[![Build Status][GHAction-image]][GHAction-link]\n[![Coverage Status][codecov-image]][codecov-link]\n\nMkAPI is a plugin for [MkDocs](https://www.mkdocs.org/),\ndesigned to facilitate the generation\nof API documentation for Python projects.\nMkAPI streamlines the documentation process by automatically extracting\ndocstrings and organizing them into a structured format, making it easier\nfor developers to maintain and share their API documentation.\n\nMkAPI supports two popular styles of docstrings:\n[Google style](http://google.github.io/styleguide/pyguide.html#38-comments-and-docstrings)\nand\n[NumPy style](https://numpydoc.readthedocs.io/en/latest/format.html#docstring-standard),\nallowing developers to choose the format that best fits their project's needs.\nSee the [Napoleon](https://sphinxcontrib-napoleon.readthedocs.io/en/latest/)\ndocumentation for details about these two styles.\n\nMkAPI is equipped with several key features that enhance the documentation\nexperience:\n\n- **Type Annotation Support**: Automatically incorporates type annotations from\n  function definitions into the documentation, reducing redundancy and\n  improving clarity.\n- **Object Type Inspection**: Analyzes Python objects to determine their types,\n  enabling accurate representation in the documentation.\n- **Docstring Inheritance**: Supports inheritance of docstring content from\n  parent classes, ensuring that subclasses retain relevant documentation without\n  duplication.\n- **Automatic Table of Contents Generation**: Generates a table of contents for\n  each package, module, and class, improving navigation within the\n  documentation.\n- **Bidirectional Links**: Creates links between the documentation and the source\n  code, allowing users to easily navigate between the two.\n\nMkAPI aims to simplify the documentation process, making it more efficient\nand accessible for developers, while ensuring that the generated documentation\nis comprehensive and easy to understand.\n\n## Installation\n\nInstall the MkAPI plugin using pip:\n\n```bash\npip install mkapi\n```\n\nMkAPI requires the following dependencies:\n\n- Python 3.10 or higher\n- MkDocs 1.6 or higher\n\n## Configuration\n\nTo configure MkAPI, add the following lines to your `mkdocs.yml` file:\n\n```yaml\nplugins:\n  - search\n  - mkapi\n```\n\n## Usage\n\nMkAPI provides two modes to generate API documentation:\nObject mode and Page mode.\n\n### Object Mode\n\nTo generate the API documentation in a Markdown source, add three colons + object\nfull name. The object can be a function, class, or module.\n\n```markdown\n::: package.module.object\n```\n\nThe Object mode is useful to embed an object's documentation\nin an arbitrary position of a Markdown source.\nFor more details, see [Object mode](https://daizutabi.github.io/mkapi/usage/object).\n\n### Page Mode\n\nUsing the Page mode, you can construct comprehensive API documentation\nfor your project.\nYou can enable this powerful feature with just one line in `mkdocs.yml`:\n\n```yaml\nnav:\n  - index.md\n  - Reference:\n    - $api/package.***\n```\n\nFor more details, see [Page mode](https://daizutabi.github.io/mkapi/usage/page/).\n\n\u003c!-- Badges --\u003e\n[pypi-v-image]: https://img.shields.io/pypi/v/mkapi.svg\n[pypi-v-link]: https://pypi.org/project/mkapi/\n[python-v-image]: https://img.shields.io/pypi/pyversions/mkapi.svg\n[python-v-link]: https://pypi.org/project/mkapi\n[GHAction-image]: https://github.com/daizutabi/mkapi/actions/workflows/ci.yaml/badge.svg?branch=main\u0026event=push\n[GHAction-link]: https://github.com/daizutabi/mkapi/actions?query=event%3Apush+branch%3Amain\n[codecov-image]: https://codecov.io/github/daizutabi/mkapi/coverage.svg?branch=main\n[codecov-link]: https://codecov.io/github/daizutabi/mkapi?branch=main\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdaizutabi%2Fmkapi","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdaizutabi%2Fmkapi","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdaizutabi%2Fmkapi/lists"}