Mkdocs-autoapi

Latest version: v0.3.2

Safety actively analyzes 681812 Python packages for vulnerabilities to keep your Python projects secure.

Scan your dependencies

0.3.1

[View Changes on GitHub](https://github.com/jcayers20/mkdocs-autoapi/compare/0.3.0...0.3.1)

Developer Support

- Added GitHub Actions for automated package publishing and release/milestone
management on push to the `main` branch

0.3.0

[View Changes on GitHub](https://github.com/jcayers20/mkdocs-autoapi/compare/0.2.1...0.3.0)

Developer Support

- Added pre-commit hooks for code formatting and linting
- Added a development guide (`CONTRIBUTING.md`) to the documentation
- Added some logging to the plugin to help with debugging

Features

- Renamed all existing configuration options to align with names used in
`sphinx-autoapi`:
- `project_root` to `autoapi_dir`
- `exclude` to `autoapi_ignore`
- `generate_local_output` to `autoapi_keep_files`
- `output_dir` to `autoapi_root`
- Added new configuration options based on `sphinx-autoapi`:
- `autoapi_file_patterns`: Define which files to include in the auto-generated
documentation
- `autoapi_generate_api_docs`: Define whether to generate API documentation
- `autoapi_add_nav_entry`: Define whether to add a navigation entry for the
API documentation

0.2.1

[View Changes on GitHub](https://github.com/jcayers20/mkdocs-autoapi/compare/0.2.0...0.2.1)

Bug Fixes

- Fixed an ill-formed link in the requirements documentation
- Fixed a typo in a function name (this function was not user-facing)

0.2.0

[View Changes on GitHub](https://github.com/jcayers20/mkdocs-autoapi/compare/0.1.6...0.2.0)

Features

- Added documentation
- Added new configuration options:
- `generate_local_output`: Define whether to create local copies of the
auto-generated API documentation
- `output_dir`: Define the directory in which the auto-generated API
documentation will be stored
- Various bug fixes and improvements

0.1.6

[View on GitHub](https://github.com/jcayers20/mkdocs-autoapi/tree/0.1.6)

First working version of the plugin.

Links

Releases

© 2024 Safety CLI Cybersecurity Inc. All Rights Reserved.