| Name | mkdocs-autoapi JSON |
| Version |
0.1.5
JSON |
| download |
| home_page | None |
| Summary | MkDocs plugin providing automatic API reference generation |
| upload_time | 2024-06-06 13:23:57 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.6 |
| license | None |
| keywords |
mkdocs
documentation
api
autoapi
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# mkdocs-autoapi
## Description
`mkdocs-autoapi` is a MkDocs plugin that automatically generates API
documentation from your project's source code. The idea for the plugin comes
from this [recipe](https://mkdocstrings.github.io/recipes/#automatic-code-reference-pages)
in the MkDocs documentation.
## Installation
### Requirements
* Python version 3.6 or higher
* MkDocs version 1.4.0 or higher
* mkdocstrings version 0.19.0 or higher
### Installation via `pip`
We recommend installing this package with `pip`:
```bash
pip install mkdocs-autoapi
```
## Usage
### Basic Usage
To use the plugin, add the following configuration to your `mkdocs.yml` file:
```yaml
plugins:
- ... other plugin configuration ...
- mkdocs-autoapi
- mkdocstrings
```
### Setting the Project Root
By default, the plugin will use the current working directory as the project
root. If you would like to use a different directory, you can specify a value
in the `project_root` configuration option:
```yaml
plugins:
- ... other plugin configuration ...
- mkdocs-autoapi:
project_root: /path/to/project/root
- mkdocstrings
```
### Excluding Patterns
You can exclude files and directories from the documentation by specifying a
value in the `exclude` configuration option. This option accepts a list of
glob patterns. Note that the following patterns are always excluded:
* `**/.venv/**/`
* `**/venv/**/`
As an example, suppose your project has the following structure:
```tree
project/
docs/
index.md
module/
__init__.py
lorem.py
ipsum.py
dolor.py
second_module/
__init__.py
lorem.py
sit.py
amet.py
venv/
mkdocs.yml
README.md
```
To exclude all files named `lorem.py`, you can add the following configuration
to your `mkdocs.yml` file:
```yaml
plugins:
- ... other plugin configuration ...
- mkdocs-autoapi:
exclude:
- "**/lorem.py"
- mkdocstrings
```
## Contributing
Contributions are always welcome! Please submit a pull request or open an issue
to get started.
## License
This project is licensed under the MIT License. See the [LICENSE](https://github.com/jcayers20/mkdocs-autoapi/blob/main/LICENSE) file
for more information.
Raw data
{
"_id": null,
"home_page": null,
"name": "mkdocs-autoapi",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": null,
"keywords": "mkdocs, documentation, api, autoapi",
"author": null,
"author_email": "Jacob Ayers <jcayers20@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/34/9e/d695ee1affa69b164f7a4d4092264026766f8ea8773c355f2f201e2023ca/mkdocs_autoapi-0.1.5.tar.gz",
"platform": null,
"description": "# mkdocs-autoapi\r\n\r\n## Description\r\n\r\n`mkdocs-autoapi` is a MkDocs plugin that automatically generates API\r\ndocumentation from your project's source code. The idea for the plugin comes\r\nfrom this [recipe](https://mkdocstrings.github.io/recipes/#automatic-code-reference-pages)\r\nin the MkDocs documentation.\r\n\r\n## Installation\r\n\r\n### Requirements\r\n\r\n* Python version 3.6 or higher\r\n* MkDocs version 1.4.0 or higher\r\n* mkdocstrings version 0.19.0 or higher\r\n\r\n### Installation via `pip`\r\n\r\nWe recommend installing this package with `pip`:\r\n\r\n```bash\r\npip install mkdocs-autoapi\r\n```\r\n\r\n## Usage\r\n\r\n### Basic Usage\r\n\r\nTo use the plugin, add the following configuration to your `mkdocs.yml` file:\r\n\r\n```yaml\r\nplugins:\r\n - ... other plugin configuration ...\r\n - mkdocs-autoapi\r\n - mkdocstrings\r\n```\r\n\r\n### Setting the Project Root\r\n\r\nBy default, the plugin will use the current working directory as the project\r\nroot. If you would like to use a different directory, you can specify a value\r\nin the `project_root` configuration option:\r\n\r\n```yaml\r\nplugins:\r\n - ... other plugin configuration ...\r\n - mkdocs-autoapi:\r\n project_root: /path/to/project/root\r\n - mkdocstrings\r\n```\r\n\r\n### Excluding Patterns\r\n\r\nYou can exclude files and directories from the documentation by specifying a\r\nvalue in the `exclude` configuration option. This option accepts a list of\r\nglob patterns. Note that the following patterns are always excluded:\r\n\r\n* `**/.venv/**/`\r\n* `**/venv/**/`\r\n\r\nAs an example, suppose your project has the following structure:\r\n\r\n```tree\r\nproject/\r\n docs/\r\n index.md\r\n module/\r\n __init__.py\r\n lorem.py\r\n ipsum.py\r\n dolor.py\r\n second_module/\r\n __init__.py\r\n lorem.py\r\n sit.py\r\n amet.py\r\n venv/\r\n mkdocs.yml\r\n README.md\r\n```\r\n\r\nTo exclude all files named `lorem.py`, you can add the following configuration\r\nto your `mkdocs.yml` file:\r\n\r\n```yaml\r\nplugins:\r\n - ... other plugin configuration ...\r\n - mkdocs-autoapi:\r\n exclude:\r\n - \"**/lorem.py\"\r\n - mkdocstrings\r\n```\r\n\r\n## Contributing\r\n\r\nContributions are always welcome! Please submit a pull request or open an issue\r\nto get started.\r\n\r\n## License\r\n\r\nThis project is licensed under the MIT License. See the [LICENSE](https://github.com/jcayers20/mkdocs-autoapi/blob/main/LICENSE) file\r\nfor more information.\r\n",
"bugtrack_url": null,
"license": null,
"summary": "MkDocs plugin providing automatic API reference generation",
"version": "0.1.5",
"project_urls": {
"Issues": "https://github.com/jcayers20/mkdocs-autoapi/issues",
"License": "https://github.com/jcayers20/mkdocs-autoapi/blob/main/LICENSE",
"Repository": "https://github.com/jcayers20/mkdocs-autoapi"
},
"split_keywords": [
"mkdocs",
" documentation",
" api",
" autoapi"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "41469587a1a0a449ed1ca3e55eb09e59ff720287cece6bbc48007e1581c220ba",
"md5": "e7e163dfe169b2f337af36902b2e9f21",
"sha256": "430b50199875791e47a3186085b943a908973a4548a6e186941b028447b7f616"
},
"downloads": -1,
"filename": "mkdocs_autoapi-0.1.5-py3-none-any.whl",
"has_sig": false,
"md5_digest": "e7e163dfe169b2f337af36902b2e9f21",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 20069,
"upload_time": "2024-06-06T13:23:55",
"upload_time_iso_8601": "2024-06-06T13:23:55.462056Z",
"url": "https://files.pythonhosted.org/packages/41/46/9587a1a0a449ed1ca3e55eb09e59ff720287cece6bbc48007e1581c220ba/mkdocs_autoapi-0.1.5-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "349ed695ee1affa69b164f7a4d4092264026766f8ea8773c355f2f201e2023ca",
"md5": "ea091a67e950fa2c4453cf0b25735b36",
"sha256": "c3664fef984d6173d288e6bdb7aabe58f9689daaa3e05d7c408ebf632a000dd7"
},
"downloads": -1,
"filename": "mkdocs_autoapi-0.1.5.tar.gz",
"has_sig": false,
"md5_digest": "ea091a67e950fa2c4453cf0b25735b36",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 16894,
"upload_time": "2024-06-06T13:23:57",
"upload_time_iso_8601": "2024-06-06T13:23:57.015814Z",
"url": "https://files.pythonhosted.org/packages/34/9e/d695ee1affa69b164f7a4d4092264026766f8ea8773c355f2f201e2023ca/mkdocs_autoapi-0.1.5.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-06-06 13:23:57",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "jcayers20",
"github_project": "mkdocs-autoapi",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "mkdocs-autoapi"
}
