| Name | mkapi JSON |
| Version |
4.0.1
JSON |
| download |
| home_page | None |
| Summary | A plugin for MkDocs to generate API documentation |
| upload_time | 2025-02-17 01:57:29 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.10 |
| license | MIT License Copyright (c) 2020-present daizutabi <daizutabi@gmail.com> Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
| keywords |
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# MkAPI
[![PyPI Version][pypi-v-image]][pypi-v-link]
[![Python Version][python-v-image]][python-v-link]
[![Build Status][GHAction-image]][GHAction-link]
[![Coverage Status][codecov-image]][codecov-link]
MkAPI is a plugin for [MkDocs](https://www.mkdocs.org/),
designed to facilitate the generation
of API documentation for Python projects.
MkAPI streamlines the documentation process by automatically extracting
docstrings and organizing them into a structured format, making it easier
for developers to maintain and share their API documentation.
MkAPI supports two popular styles of docstrings:
[Google style](http://google.github.io/styleguide/pyguide.html#38-comments-and-docstrings)
and
[NumPy style](https://numpydoc.readthedocs.io/en/latest/format.html#docstring-standard),
allowing developers to choose the format that best fits their project's needs.
See the [Napoleon](https://sphinxcontrib-napoleon.readthedocs.io/en/latest/)
documentation for details about these two styles.
MkAPI is equipped with several key features that enhance the documentation
experience:
- **Type Annotation Support**: Automatically incorporates type annotations from
function definitions into the documentation, reducing redundancy and
improving clarity.
- **Object Type Inspection**: Analyzes Python objects to determine their types,
enabling accurate representation in the documentation.
- **Docstring Inheritance**: Supports inheritance of docstring content from
parent classes, ensuring that subclasses retain relevant documentation without
duplication.
- **Automatic Table of Contents Generation**: Generates a table of contents for
each package, module, and class, improving navigation within the
documentation.
- **Bidirectional Links**: Creates links between the documentation and the source
code, allowing users to easily navigate between the two.
MkAPI aims to simplify the documentation process, making it more efficient
and accessible for developers, while ensuring that the generated documentation
is comprehensive and easy to understand.
## Installation
Install the MkAPI plugin using pip:
```bash
pip install mkapi
```
MkAPI requires the following dependencies:
- Python 3.10 or higher
- MkDocs 1.6 or higher
## Configuration
To configure MkAPI, add the following lines to your `mkdocs.yml` file:
```yaml
plugins:
- mkapi
```
## Usage
MkAPI provides two modes to generate API documentation:
Object mode and Page mode.
### Object Mode
To generate the API documentation in a Markdown source, add three colons + object
full name. The object can be a function, class, or module.
```markdown
::: package.module.object
```
The Object mode is useful to embed an object's documentation
in an arbitrary position of a Markdown source.
For more details, see [Object mode](https://daizutabi.github.io/mkapi/usage/object).
### Page Mode
Using the Page mode, you can construct comprehensive API documentation
for your project.
You can enable this powerful feature with just one line in `mkdocs.yml`:
```yaml
nav:
- index.md
- Reference:
- $api/package.***
```
For more details, see [Page mode](https://daizutabi.github.io/mkapi/usage/page/).
<!-- Badges -->
[pypi-v-image]: https://img.shields.io/pypi/v/mkapi.svg
[pypi-v-link]: https://pypi.org/project/mkapi/
[python-v-image]: https://img.shields.io/pypi/pyversions/mkapi.svg
[python-v-link]: https://pypi.org/project/mkapi
[GHAction-image]: https://github.com/daizutabi/mkapi/actions/workflows/ci.yaml/badge.svg?branch=main&event=push
[GHAction-link]: https://github.com/daizutabi/mkapi/actions?query=event%3Apush+branch%3Amain
[codecov-image]: https://codecov.io/github/daizutabi/mkapi/coverage.svg?branch=main
[codecov-link]: https://codecov.io/github/daizutabi/mkapi?branch=main
Raw data
{
"_id": null,
"home_page": null,
"name": "mkapi",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": null,
"keywords": null,
"author": null,
"author_email": "daizutabi <daizutabi@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/e2/6a/a41943ddbe4f885eea154eae2b4828edec5fc142dd48795fe1425fc07164/mkapi-4.0.1.tar.gz",
"platform": null,
"description": "# 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 - 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<!-- Badges -->\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&event=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",
"bugtrack_url": null,
"license": "MIT License Copyright (c) 2020-present daizutabi <daizutabi@gmail.com> Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.",
"summary": "A plugin for MkDocs to generate API documentation",
"version": "4.0.1",
"project_urls": {
"Documentation": "https://daizutabi.github.io/mkapi/",
"Issues": "https://github.com/daizutabi/mkapi/issues",
"Source": "https://github.com/daizutabi/mkapi"
},
"split_keywords": [],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "7b2b6ce093cd0ad9d88fb4099d24d98e2d4f32b551787652e7cc83eff0763932",
"md5": "6a6f47e29bc5d434c2494b748cd7a00c",
"sha256": "26d0338cd53beb66574b0e2f7359748e9cefe315d9e10993d81d6f570ec41769"
},
"downloads": -1,
"filename": "mkapi-4.0.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "6a6f47e29bc5d434c2494b748cd7a00c",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 27380,
"upload_time": "2025-02-17T01:57:26",
"upload_time_iso_8601": "2025-02-17T01:57:26.646827Z",
"url": "https://files.pythonhosted.org/packages/7b/2b/6ce093cd0ad9d88fb4099d24d98e2d4f32b551787652e7cc83eff0763932/mkapi-4.0.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "e26aa41943ddbe4f885eea154eae2b4828edec5fc142dd48795fe1425fc07164",
"md5": "91c522279b8104fe0707bdf446f67523",
"sha256": "f1c9819823b34a07dac25eca522f97757a7606c1b5cf4b76d49e9785f8671797"
},
"downloads": -1,
"filename": "mkapi-4.0.1.tar.gz",
"has_sig": false,
"md5_digest": "91c522279b8104fe0707bdf446f67523",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 47905,
"upload_time": "2025-02-17T01:57:29",
"upload_time_iso_8601": "2025-02-17T01:57:29.017727Z",
"url": "https://files.pythonhosted.org/packages/e2/6a/a41943ddbe4f885eea154eae2b4828edec5fc142dd48795fe1425fc07164/mkapi-4.0.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-02-17 01:57:29",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "daizutabi",
"github_project": "mkapi",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "mkapi"
}
